From 7d4c21cbe11edfa61be4338120b184355f3c213e Mon Sep 17 00:00:00 2001 From: "James E. Blair" Date: Wed, 12 Aug 2015 08:39:41 -0700 Subject: [PATCH] Add section on review criteria Change-Id: I2906738bbd17b36c0f096ed75c0516832d6a3d0f --- doc/source/project.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/doc/source/project.rst b/doc/source/project.rst index 4203c535d2..81ec41328a 100644 --- a/doc/source/project.rst +++ b/doc/source/project.rst @@ -197,3 +197,37 @@ Infrastructure Root Team Some individuals may need root access to individual servers; in these cases the infra-core group may grant root access on a limited basis. + +Review Criteria +=============== + +We review each others changes before they are merged. This helps us +improve the quality of the code we produce as well as ensure that we +are working together as a team. Generally we expect at least two +members of the core review team to approve a change before it is +merged, but we are flexible in this requirement -- typo fixes, or +other simple changes may be approved with less formality. + +The primary purpose of change review is to catch substantial errors +before they are merged. In order to keep this process useful and +avoid frustration for both authors and reviewers, please do not leave +negative reviews for insubstantial faults or potential improvements. +The purpose is not to make someone else's code match your vision of +perfection, but to enable all of us to work together on a project. + +Please use discretion when deciding what is important enough for +someone to spend the time to rework and for you to spend the time +re-reviewing. Sometimes minor things are important, such as +consistent use of hyphens versus underscores in a configuration +language. Sometimes they are not, such as whitespace in +documentation. + +If you would like to mention minor improvements such as this, feel +free to do so, but please do not leave a negative score on the review. +If you mention them along with other more substantial criticisms, +please note them in a review, for example, with "(nit)" or "(not a +-1)" or "you may want to fix this if you are updating the patch +anyway". + +Please also see the section in the Infrastructure Manual on `peer review +`_.