diff options
| author | Kubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com> | 2019-01-15 18:23:03 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-01-15 18:23:03 -0800 |
| commit | 06ff392d1876b39901acaf3303ba54a7790cc2ea (patch) | |
| tree | d6df9967b004bb2c03b7f846a1c6e3f6284a4aff /contributors/guide | |
| parent | acf6259d43c1e4ff72f1c21bd6698ad8e397042e (diff) | |
| parent | a156dd10349effb8948169066b639e5a001fb5a1 (diff) | |
Merge pull request #3099 from eduartua/issue-3064-2
File moved (k/community/contributors/devel/collab.md) - Created tombstone file and updated URL in other files
Diffstat (limited to 'contributors/guide')
| -rw-r--r-- | contributors/guide/README.md | 2 | ||||
| -rw-r--r-- | contributors/guide/collab.md | 35 |
2 files changed, 36 insertions, 1 deletions
diff --git a/contributors/guide/README.md b/contributors/guide/README.md index 20c75be4..3ed78d07 100644 --- a/contributors/guide/README.md +++ b/contributors/guide/README.md @@ -159,7 +159,7 @@ If you find that this is not the case, please complain loudly. As a potential contributor, your changes and ideas are welcome at any hour of the day or night, weekdays, weekends, and holidays. Please do not ever hesitate to ask a question or send a pull request. -Check out our [community guiding principles](/contributors/devel/collab.md) on how to create great code as a big group. +Check out our [community guiding principles](/contributors/guide/collab.md) on how to create great code as a big group. Beginner focused information can be found below in [Open a Pull Request](#open-a-pull-request) and [Code Review](#code-review). diff --git a/contributors/guide/collab.md b/contributors/guide/collab.md new file mode 100644 index 00000000..73ddebb9 --- /dev/null +++ b/contributors/guide/collab.md @@ -0,0 +1,35 @@ +# On Collaborative Development + +## Code reviews + +All changes must be code reviewed. For non-maintainers this is obvious, since +you can't commit anyway. But even for maintainers, we want all changes to get at +least one review, preferably (for non-trivial changes obligatorily) from someone +who knows the areas the change touches. For non-trivial changes we may want two +reviewers. The primary reviewer will make this decision and nominate a second +reviewer, if needed. Except for trivial changes, PRs should not be committed +until relevant parties (e.g. owners of the subsystem affected by the PR) have +had a reasonable chance to look at PR in their local business hours. + +Most PRs will find reviewers organically. If a maintainer intends to be the +primary reviewer of a PR they should set themselves as the assignee on GitHub +and say so in a reply to the PR. Only the primary reviewer of a change should +actually do the merge, except in rare cases (e.g. they are unavailable in a +reasonable timeframe). + +If a PR has gone 2 work days without an owner emerging, please poke the PR +thread and ask for a reviewer to be assigned. + +Except for rare cases, such as trivial changes (e.g. typos, comments) or +emergencies (e.g. broken builds), maintainers should not merge their own +changes. + +Expect reviewers to request that you avoid [common go style +mistakes](https://github.com/golang/go/wiki/CodeReviewComments) in your PRs. + +## Assigned reviews + +Maintainers can assign reviews to other maintainers, when appropriate. The +assignee becomes the shepherd for that PR and is responsible for merging the PR +once they are satisfied with it or else closing it. The assignee might request +reviews from non-maintainers. |