@@ -19,15 +19,16 @@ There are a number of requirements that need to be met in order for reviewing to
19
19
20
20
- Reviewers must have a sufficient ** understanding of the code** under review.
21
21
> This is important to help spot non-obvious, unintentional side effects of a given change.
22
- - Pull requests must provide (1) a concise high-level ** description of the change** and (2) the ** rationale** behind it.
23
- For the rationale to be even more useful, authors are encouraged to list potential ** points of contention** .
22
+ - Pull request authors must provide (1) a concise high-level ** description of the change** and (2) the ** rationale** behind it.
23
+ For the rationale to be even more useful, authors are encouraged to list potential ** points of contention** ,
24
+ ** compromises** that needed to be made, ** alternative approaches** that have been considered, et cetera.
24
25
> Reviewing code is difficult and reviewers only have a limited amount of time to do it.
25
26
> Jump-starting the review process by not making the reviewer puzzle together the intention and context
26
27
> of a pull request will not only speed things up but also improve the quality of the review.
27
28
- Reviewers must have a good idea on whether they are the ** right person to approve** the change.
28
29
> Knowledge of the code under review is an obvious but not the only criterium for answering this question.
29
30
> The reviewer also needs to decide if they can make the decision alone or if the PR needs to go through
30
- > the [ major change process] [ mcp ] , if they can perform the review in a timely fashion,
31
+ > the [ major change process] [ mcp ] , if they can perform the review sufficiently thorough and in a timely fashion,
31
32
> and if they are impartial enough to provide a sufficiently unbiased perspective.
32
33
33
34
@@ -86,7 +87,7 @@ This section lists a few common cases together with guidance on how to deal with
86
87
- If you don't know the code well or already have too much on your plate,
87
88
ask highfive to roll the dice again via ` r? rust-lang/compiler-contributors ` .
88
89
89
- You can also always ask specific compiler team members for help finding a reviewer.
90
+ You can also always ask for help on the ` #t- compiler/reviews ` Zulip stream for finding a reviewer.
90
91
That being said, you are always welcome to do an initial review (to the extent you are comformtable with)
91
92
and then pass the PR on to the final reviewer.
92
93
This way the PR author will get helpful feedback sooner and subsequent reviewers will have less work to do.
@@ -140,9 +141,8 @@ This section lists a few common cases together with guidance on how to deal with
140
141
* ### Nobody understands the code that's being changed
141
142
Sometimes there is a bug in some code that nobody understands anymore.
142
143
The original authors are unavailable and it is hard to gauge the implications of a proposed fix.
143
- In such a case it is a good idea for reviewers to nominate the PR (by tagging it with ` I-nominated ` )
144
- in order to get it in front of more eyes during the compiler team's triage meeting.
145
- In such cases it is also especially valuable to gather and document as much information as possible on the issue,
144
+ In such a case it is a good idea for reviewers to ask on the ` #t-compiler/reviews ` Zulip stream for additional help.
145
+ It is also especially valuable to gather and document as much information as possible about the issue,
146
146
such as a description of the problem being fixed, points of unclarity, potential risks,
147
147
alternatives that have been considered, et cetera.
148
148
Reviewers should ask PR authors to add this kind of information as comments in the code
0 commit comments