diff options
| author | Jorge O. Castro <jorgec@vmware.com> | 2020-08-17 20:09:30 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-17 17:09:30 -0700 |
| commit | d27cb26831069267511858cec49b9fa3e78ff749 (patch) | |
| tree | b509d80ccc66003c5fbb71c94d7def72b7ea6261 /contributors/guide/contributing.md | |
| parent | 042df2dedefecc0f5928f068c1c6ee1b1930f623 (diff) | |
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 <jorgec@vmware.com>
* Reformat ToC headers, move KISS section higher
Signed-off-by: Jorge O. Castro <jorgec@vmware.com>
Diffstat (limited to 'contributors/guide/contributing.md')
| -rw-r--r-- | contributors/guide/contributing.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/contributors/guide/contributing.md b/contributors/guide/contributing.md index a2742cf9..e66da774 100644 --- a/contributors/guide/contributing.md +++ b/contributors/guide/contributing.md @@ -41,13 +41,17 @@ For general questions and troubleshooting, use the [standard lines of communicat To check out code to work on, please refer to [the GitHub Workflow Guide](./github-workflow.md). -## Open a Pull Request +The full workflow for a pull request is documented here: + +- [Kubernetes-specific github workflow](pull-requests.md#the-testing-and-merge-workflow). + +That document is comprehensive and detailed, for purposes of a typical pull request we will cover the initial and simple use case here: + +## Opening a Pull Request Pull requests are often called a "PR". 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: -- [Kubernetes-specific github workflow](pull-requests.md#the-testing-and-merge-workflow). - The first difference you'll see is that a bot will begin applying structured labels to your PR. 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: ## Issues Management or Triage Have you ever noticed the total number of [open issues](https://issues.k8s.io)? -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. +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. Refer to the [Issue Triage Guidelines](/contributors/guide/issue-triage.md) for more information. |