@@ -111,7 +111,7 @@ Workflow
111111* Set the :ref: `milestone <pr-milestones >`.
112112* Keep an eye on the :ref: `number of commits <pr-squashing >`.
113113* Approve if all of the above topics are handled.
114- * :ref: `Merge <pr-merging >` if a sufficient number of approvals is reached.
114+ * :ref: `Merge <pr-merging >` if a :ref: ` sufficient number of approvals < pr-approval >` is reached.
115115
116116.. _pr-guidelines-details :
117117
@@ -190,10 +190,27 @@ All Pull Requests should target the main branch. The milestone tag triggers
190190an :ref: `automatic backport <automated-backports >` for milestones which have
191191a corresponding branch.
192192
193- .. _pr-merging :
193+ .. _pr-review :
194194
195- Merging
196- -------
195+ Review
196+ ------
197+
198+ * Do not let perfect be the enemy of the good, particularly for
199+ documentation or example PRs. If you find yourself making many
200+ small suggestions, either open a PR against the original branch,
201+ push changes to the contributor branch, or merge the PR and then
202+ open a new PR against upstream.
203+
204+ * If you push to a contributor branch leave a comment explaining what
205+ you did, ex "I took the liberty of pushing a small clean-up PR to
206+ your branch, thanks for your work.". If you are going to make
207+ substantial changes to the code or intent of the PR please check
208+ with the contributor first.
209+
210+ .. _pr-approval :
211+
212+ Approval
213+ --------
197214As a guiding principle, we require two `approvals `_ from core developers (those
198215with commit rights) before merging a pull request. This two-pairs-of-eyes
199216strategy shall ensure a consistent project direction and prevent accidental
@@ -229,18 +246,22 @@ Some explicit rules following from this:
229246 A core dev should only champion one PR at a time and we should try to keep
230247 the flow of championed PRs reasonable.
231248
232- After giving the last required approval, the author of the approval should
233- merge the PR. PR authors should not self-merge except for when another reviewer
234- explicitly allows it (e.g., "Approve modulo CI passing, may self merge when
235- green", or "Take or leave the comments. You may self merge".).
236-
237249.. _pr-automated-tests :
238250
239251Automated tests
240252---------------
241253Before being merged, a PR should pass the :ref: `automated-tests `. If you are
242254unsure why a test is failing, ask on the PR or in our :ref: `communication-channels `
243255
256+ .. _pr-merging :
257+
258+ Merging
259+ -------
260+ After giving the last required :ref: `approval <pr-approval >`, the author of the
261+ approval should merge the PR. PR authors should not self-merge except for when
262+ another reviewer explicitly allows it (e.g., "Approve modulo CI passing, may
263+ self-merge when green", or "Take or leave the comments. You may self merge".).
264+
244265.. _pr-squashing :
245266
246267Number of commits and squashing
@@ -252,19 +273,6 @@ Number of commits and squashing
252273 about it is to eliminate binary files (ex multiple test image
253274 re-generations) and to remove upstream merges.
254275
255- * Do not let perfect be the enemy of the good, particularly for
256- documentation or example PRs. If you find yourself making many
257- small suggestions, either open a PR against the original branch,
258- push changes to the contributor branch, or merge the PR and then
259- open a new PR against upstream.
260-
261- * If you push to a contributor branch leave a comment explaining what
262- you did, ex "I took the liberty of pushing a small clean-up PR to
263- your branch, thanks for your work.". If you are going to make
264- substantial changes to the code or intent of the PR please check
265- with the contributor first.
266-
267-
268276.. _branches_and_backports :
269277
270278Branches and backports
0 commit comments