Skip to content

Commit cb97da0

Browse files
carlescufinashif
authored andcommitted
doc: contribute: Extend Reviewer Expectations with additional rules
This change was triggered by a review comment linked below: zephyrproject-rtos#83117 (comment) It extends the current Reviewer Expectations with additional rules agreed upon by multiple Zephyr contributors in order to simplify and standardize the decision-making process during PR reviews. Signed-off-by: Carles Cufi <[email protected]> Signed-off-by: Anas Nashif <[email protected]>
1 parent 0709478 commit cb97da0

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

doc/contribute/contributor_expectations.rst

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,10 +305,27 @@ Reviewer Expectations
305305
they address all non-blocking comments. PR authors should acknowledge every
306306
review comment in some way, even if it's just with an emoticon.
307307

308-
- Reviewers shall be *clear* and *concise* what changes they are requesting when the
308+
- Style changes that the reviewer disagrees with but that are not documented as
309+
part of the project can be pointed out as non-blocking, but cannot constitute
310+
a reason for a request for changes. The reviewer can optionally correct any
311+
potential inconsistencies in the tree, document the new guidelines or rules,
312+
and then enforce them as part of the review.
313+
314+
- Whenever requesting style related changes, reviewers should be able to point
315+
out the corresponding guideline, rule or rationale in the project's
316+
documentation. This does not apply to certain types of requests for changes,
317+
notably those specific to the changes being submitted (e.g. the use of a
318+
particular data structure or the choice of locking primitives).
319+
320+
- Reviewers shall be *clear* about what changes they are requesting when the
309321
"Request Changes" option is used. Requested changes shall be in the scope of
310322
the PR in question and following the contribution and style guidelines of the
311-
project.
323+
project. Furthermore, reviewers must be able to point back to the exact issues
324+
in the PR that triggered a request for changes.
325+
326+
- Reviewers should not request changes for issues which are automatically
327+
caught by CI, as this causes the pull request to remain blocked even after CI
328+
failures have been addressed and may unnecessarily delay it from being merged.
312329

313330
- Reviewers shall not close a PR due to technical or structural disagreement.
314331
If requested changes cannot be resolved within the review process, the

0 commit comments

Comments
 (0)