starlingx/docs
Code Issues Proposed changes

Add wording to ease on patch review requirements

Browse Source 
Due to recent changes in core teams, some have reduced in size to
the level where the 2 '+2' vote requirement to approve patches is
not sustainable anymore. This patch adds notes to the Code Submission
Guide to ease that requirement, when necessary.

Change-Id: I4982c74af658f28a9d28203d82d4e53df8cbcad4
Signed-off-by: Ildiko Vancsa <ildiko.vancsa@gmail.com>
This commit is contained in:
Ildiko Vancsa 2024-08-01 10:38:20 -07:00
parent e8fa92160e
commit 7c3625c18e
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/developer_resources/code-submission-guide.rst
View File

@ -91,6 +91,17 @@ Code reviews
* In order for code to get merged, two core reviewers must give the review +2. * In order for code to get merged, two core reviewers must give the review +2.
A final Workflow +1 from one core reviewer will allow the code to merge. A final Workflow +1 from one core reviewer will allow the code to merge.
Typically, the final W+1 is done by the second core reviewer. Typically, the final W+1 is done by the second core reviewer.
* While the requirement to have at least 2 ‘+2’ votes from core reviewers is set
to advocate for higher code quality through a more diverse set of eyes, in certain
cases it can also become a bottleneck. When the core team of a sub-project
becomes too small to be able to sustain the 2 ‘+2’ rule, they can reduce the
requirement to 1, however, a core reviewer should not approve their own changes,
when that is possible.
* In the above case it is further advised to seek for a higher number of ‘+1’
votes. This can ensure the changes are still thoroughly reviewed, while can also
help with increasing the number of core reviewers with a more engaged team.
* If a core reviewer sets a -2, the code cannot be merged until that reviewer * If a core reviewer sets a -2, the code cannot be merged until that reviewer
removes their -2. removes their -2.
* Authors should not review their own code and, therefore, should not +2 or W+ * Authors should not review their own code and, therefore, should not +2 or W+