diff options
| author | Mark Goddard <mark@stackhpc.com> | 2020-11-16 10:55:23 +0000 |
|---|---|---|
| committer | Mark Goddard <mark@stackhpc.com> | 2020-11-19 10:12:37 +0000 |
| commit | abc4f7c124265f9e7b72d448b2ef18d6d4e84888 (patch) | |
| tree | ec280bf3f78d3c3fbc68a002edabd2be5fd2f125 | |
| parent | 01972fc749cdabed36dab1f3020a8db4344086b8 (diff) | |
| download | kolla-abc4f7c124265f9e7b72d448b2ef18d6d4e84888.tar.gz kolla-abc4f7c124265f9e7b72d448b2ef18d6d4e84888.zip | |
docs: add code reviews to contributor guide
Change-Id: I01dba5d905b50a5ec5eefb7b9f20a2ffd557b76e
| -rw-r--r-- | doc/source/contributor/code-reviews.rst | 47 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 1 |
2 files changed, 48 insertions, 0 deletions
diff --git a/doc/source/contributor/code-reviews.rst b/doc/source/contributor/code-reviews.rst new file mode 100644 index 000000000..5fee74a1d --- /dev/null +++ b/doc/source/contributor/code-reviews.rst @@ -0,0 +1,47 @@ +============ +Code Reviews +============ + +All Kolla code must be reviewed and approved before it can be merged. Anyone +with a Gerrit account is able to provide a review. Two labels are available to +everyone: + +* +1: Approve +* -1: Changes requested + +It is also possible to leave comments without a label. In general, a review +with comments is more valuable. Comments are especially important for a +negative review. Prefer quality of reviews over quantity. + +You can watch specific patches in Gerrit via *Settings -> Watched Projects*. +The volume of emails is not too large if you subscribe to *New Changes* only. +If you do not have much time available for reviewing, consider reviewing +patches in an area that is important to you or that you understand well. + +Core reviewers +============== + +Core reviewers have additional labels available to them. + +* +2: Approve +* -2: Do not merge +* Workflow +1: Approve and ready for merge + +Zuul requires one +2 and one workflow +1, as well as a passing check, in order +for a patch to proceed to the gate. The Kolla team generally requires two +2s +before a workflow +1 may be added. We also have some non-voting Zuul jobs which +will not block a check, but should be investigated if they are failing. + +Core reviewers may still use +1 to indicate approval if they are not confident +enough about a particular patch to use +2. + +The Kolla core reviewers have the same rights of access to stable branches, so +always check the branch for a review, and use extra care with stable branches. + +Becoming a core reviewer +------------------------ + +There are no strict rules for becoming a core reviewer. Join the community, +review some patches, and demonstrate responsibility, understanding & care. If +you are interested in joining the core team, ask the PTL or another core +reviewer how to get there. diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 6e4947237..f2a05eafd 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -16,6 +16,7 @@ We welcome everyone to join our project! adding-a-new-image release-notes running-tests + code-reviews bug-triage ptl-guide release-management |