Skip to content

Commit d27cb26

Browse files
author
Jorge O. Castro
authored
Deduplify content: Remove reviewee content from the review-guidelines (#5031)
* Deduplify content: Remove reviewee content from the review-guidelines, reorganize pull request page. Signed-off-by: Jorge O. Castro <[email protected]> * Reformat ToC headers, move KISS section higher Signed-off-by: Jorge O. Castro <[email protected]>
1 parent 042df2d commit d27cb26

File tree

3 files changed

+247
-323
lines changed

3 files changed

+247
-323
lines changed

contributors/guide/contributing.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,17 @@ For general questions and troubleshooting, use the [standard lines of communicat
4141

4242
To check out code to work on, please refer to [the GitHub Workflow Guide](./github-workflow.md).
4343

44-
## Open a Pull Request
44+
The full workflow for a pull request is documented here:
45+
46+
- [Kubernetes-specific github workflow](pull-requests.md#the-testing-and-merge-workflow).
47+
48+
That document is comprehensive and detailed, for purposes of a typical pull request we will cover the initial and simple use case here:
49+
50+
## Opening a Pull Request
4551

4652
Pull requests are often called a "PR".
4753
Kubernetes generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process, but there is a layer of additional kubernetes specific (and sometimes SIG specific) differences:
4854

49-
- [Kubernetes-specific github workflow](pull-requests.md#the-testing-and-merge-workflow).
50-
5155
The first difference you'll see is that a bot will begin applying structured labels to your PR.
5256

5357
The bot may also make some helpful suggestions for commands to run in your PR to facilitate review.
@@ -127,5 +131,6 @@ If you're looking to run e2e tests on your own infrastructure, [kubetest](https:
127131
## Issues Management or Triage
128132

129133
Have you ever noticed the total number of [open issues](https://issues.k8s.io)?
130-
Helping to manage or triage these open issues can be a great contribution and a great opportunity to learn about the various areas of the project. Triaging is the word we use to describe the process of adding multiple types of descriptive labels to GitHub issues, in order to speed up routing issues to the right folks.
134+
Helping to manage or triage these open issues can be a great contribution and a great opportunity to learn about the various areas of the project.
135+
Triaging is the word we use to describe the process of adding multiple types of descriptive labels to GitHub issues, in order to speed up routing issues to the right folks.
131136
Refer to the [Issue Triage Guidelines](/contributors/guide/issue-triage.md) for more information.

0 commit comments

Comments
 (0)