@@ -332,8 +332,9 @@ Pull requests can be accepted and merged by a Python Core Developer.
332
332
1. At the bottom of the pull request page, click the ``Squash and merge ``
333
333
button.
334
334
335
- 2. Replace the reference to GitHub PR #NNNN into GH-NNNN. If the title
336
- is too long, the pull request number can be added to the body.
335
+ 2. Replace the reference to GitHub pull request ``#NNNN `` with ``GH-NNNN ``.
336
+ If the title is too long, the pull request number can be added to the
337
+ message body.
337
338
338
339
3. Adjust and clean up the commit message.
339
340
@@ -385,8 +386,8 @@ commands::
385
386
The above commands will print out the hash of the commit containing
386
387
``"bpo-12345" `` as part of the commit message.
387
388
388
- When formatting the message for a backport commit: leave it as the the original
389
- one, pointing to the original pull request number as well (`` GH-NNNN ``) .
389
+ When formatting the commit message for a backport commit: leave the original
390
+ one as is and delete the number of the backport pull request .
390
391
391
392
Example of good backport commit message::
392
393
@@ -395,6 +396,14 @@ Example of good backport commit message::
395
396
* Add method A to the spam module
396
397
* Update the documentation of the spam module
397
398
399
+ (cherry picked from commit 62adc55)
400
+
401
+ Example of bad backport commit message::
402
+
403
+ bpo-12345: Improve the spam module (GH-777) (#888)
404
+
405
+ * Add method A to the spam module
406
+ * Update the documentation of the spam module
398
407
399
408
Editing a Pull Request Prior to Merging
400
409
---------------------------------------
0 commit comments