github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-09 13:12:20 +00:00
Code Issues Projects Releases Wiki Activity

Add reviewable notes to CONTRIBUTING

Browse Source
This commit is contained in:
Tim Hockin
2016-11-10 23:47:13 -08:00
parent cfbb0eb2ff
commit 9b4bc58a10
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/devel/development.md
View File

@@ -228,6 +228,23 @@ git push -f origin my-feature
**Note:** If you have write access, please refrain from using the GitHub UI for creating PRs, because GitHub will create the PR branch inside the main repository rather than inside your fork. **Note:** If you have write access, please refrain from using the GitHub UI for creating PRs, because GitHub will create the PR branch inside the main repository rather than inside your fork.
### Getting a code review
Once your pull request has been opened it will be assigned to one or more
reviewers. Those reviewers will do a thorough code review, looking for
correctness, bugs, opportunities for improvement, documentation and comments,
and style.
Very small PRs are easy to review. Very large PRs are very difficult to
review. Github has a built-in code review tool, which is what most people use.
At the assigned reviewer's discretion, a PR may be switched to use
[Reviewable](https://reviewable.k8s.io) instead. Once a PR is switched to
Reviewable, please ONLY send or reply to comments through reviewable. Mixing
code review tools can be very confusing.
See [Faster Reviews](faster_reviews.md) for some thoughts on how to streamline
the review process.
### When to retain commits and when to squash ### When to retain commits and when to squash
Upon merge, all git commits should represent meaningful milestones or units of Upon merge, all git commits should represent meaningful milestones or units of
@@ -240,9 +257,6 @@ fixups (e.g. automated doc formatting), use one or more commits for the
changes to tooling and a final commit to apply the fixup en masse. This makes changes to tooling and a final commit to apply the fixup en masse. This makes
reviews much easier. reviews much easier.
See [Faster Reviews](faster_reviews.md) for more details.
## Testing ## Testing
Three basic commands let you run unit, integration and/or e2e tests: Three basic commands let you run unit, integration and/or e2e tests: