@@ -109,9 +109,10 @@ Workflow
109
109
* The PR should :ref: `target the main branch <pr-branch-selection >`.
110
110
* Tag with descriptive :ref: `labels <pr-labels >`.
111
111
* Set the :ref: `milestone <pr-milestones >`.
112
- * Keep an eye on the :ref: `number of commits <pr-squashing >` .
112
+ * :ref: `Review <pr-review >` the contents .
113
113
* Approve if all of the above topics are handled.
114
- * :ref: `Merge <pr-merging >` if a sufficient number of approvals is reached.
114
+ * Keep an eye on the :ref: `number of commits <pr-squashing >`.
115
+ * :ref: `Merge <pr-merging >` if a :ref: `sufficient number of approvals <pr-approval >` is reached.
115
116
116
117
.. _pr-guidelines-details :
117
118
@@ -190,10 +191,27 @@ All Pull Requests should target the main branch. The milestone tag triggers
190
191
an :ref: `automatic backport <automated-backports >` for milestones which have
191
192
a corresponding branch.
192
193
193
- .. _pr-merging :
194
+ .. _pr-review :
194
195
195
- Merging
196
- -------
196
+ Review
197
+ ------
198
+
199
+ * Do not let perfect be the enemy of the good, particularly for
200
+ documentation or example PRs. If you find yourself making many
201
+ small suggestions, either open a PR against the original branch,
202
+ push changes to the contributor branch, or merge the PR and then
203
+ open a new PR against upstream.
204
+
205
+ * If you push to a contributor branch leave a comment explaining what
206
+ you did, ex "I took the liberty of pushing a small clean-up PR to
207
+ your branch, thanks for your work.". If you are going to make
208
+ substantial changes to the code or intent of the PR please check
209
+ with the contributor first.
210
+
211
+ .. _pr-approval :
212
+
213
+ Approval
214
+ --------
197
215
As a guiding principle, we require two `approvals `_ from core developers (those
198
216
with commit rights) before merging a pull request. This two-pairs-of-eyes
199
217
strategy shall ensure a consistent project direction and prevent accidental
@@ -229,18 +247,22 @@ Some explicit rules following from this:
229
247
A core dev should only champion one PR at a time and we should try to keep
230
248
the flow of championed PRs reasonable.
231
249
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
-
237
250
.. _pr-automated-tests :
238
251
239
252
Automated tests
240
253
---------------
241
254
Before being merged, a PR should pass the :ref: `automated-tests `. If you are
242
255
unsure why a test is failing, ask on the PR or in our :ref: `communication-channels `
243
256
257
+ .. _pr-merging :
258
+
259
+ Merging
260
+ -------
261
+ After giving the last required :ref: `approval <pr-approval >`, the author of the
262
+ approval should merge the PR. PR authors should not self-merge except for when
263
+ another reviewer explicitly allows it (e.g., "Approve modulo CI passing, may
264
+ self-merge when green", or "Take or leave the comments. You may self merge".).
265
+
244
266
.. _pr-squashing :
245
267
246
268
Number of commits and squashing
@@ -252,19 +274,6 @@ Number of commits and squashing
252
274
about it is to eliminate binary files (ex multiple test image
253
275
re-generations) and to remove upstream merges.
254
276
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
-
268
277
.. _branches_and_backports :
269
278
270
279
Branches and backports
0 commit comments