Skip to content

Commit 1c9b0b1

Browse files
committed
Issue #199: Tweak documentation after GH-275
1 parent 6360d7f commit 1c9b0b1

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

gitbootcamp.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -332,8 +332,9 @@ Pull requests can be accepted and merged by a Python Core Developer.
332332
1. At the bottom of the pull request page, click the ``Squash and merge``
333333
button.
334334

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.
337338

338339
3. Adjust and clean up the commit message.
339340

@@ -385,8 +386,8 @@ commands::
385386
The above commands will print out the hash of the commit containing
386387
``"bpo-12345"`` as part of the commit message.
387388

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.
390391

391392
Example of good backport commit message::
392393

@@ -395,6 +396,14 @@ Example of good backport commit message::
395396
* Add method A to the spam module
396397
* Update the documentation of the spam module
397398

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
398407

399408
Editing a Pull Request Prior to Merging
400409
---------------------------------------

pullrequest.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,8 @@ happened (detail should be good enough that a core developer reading the
225225
commit message understands the justification for the change).
226226

227227
Check :ref:`the git bootcamp <accepting-and-merging-a-pr>` for further
228-
instructions on how the commit should look like when merging a pull request.
228+
instructions on how the commit message should look like when merging a pull
229+
request.
229230

230231

231232
.. _cla:

0 commit comments

Comments
 (0)