summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKubernetes Submit Queue <k8s-merge-robot@users.noreply.github.com>2016-11-28 11:43:16 -0800
committerGitHub <noreply@github.com>2016-11-28 11:43:16 -0800
commit2dd453a558c70e3033dacba152a208686d1d0ce8 (patch)
tree85c2ef52d1710409011789e086385a9ea8f28234
parent9fb8b6a19124b56607c57863125a58a38da8ec15 (diff)
parent8dc9c4ddcc56f51ad9781b6250d950939e8d010a (diff)
Merge pull request #36634 from thockin/reviewable-doc
Automatic merge from submit-queue Add reviewable notes to CONTRIBUTING @kubernetes/contributor-experience
-rw-r--r--development.md20
1 files changed, 17 insertions, 3 deletions
diff --git a/development.md b/development.md
index 050419e2..1349e003 100644
--- a/development.md
+++ b/development.md
@@ -194,6 +194,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.
+### 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
Upon merge, all git commits should represent meaningful milestones or units of
@@ -206,9 +223,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
reviews much easier.
-See [Faster Reviews](faster_reviews.md) for more details.
-
-
## Testing
Three basic commands let you run unit, integration and/or e2e tests: