Skip to content

Commit 7ff921b

Browse files
Replace bpo- with gh- (#830)
Co-authored-by: Jelle Zijlstra <[email protected]>
1 parent fb18748 commit 7ff921b

File tree

4 files changed

+20
-18
lines changed

4 files changed

+20
-18
lines changed

committing.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,19 +114,19 @@ manually. The ``Misc/NEWS.d`` directory contains a sub-directory named
114114
``next``, which contains various sub-directories representing classifications
115115
for what was affected (e.g. ``Misc/NEWS.d/next/Library`` for changes relating
116116
to the standard library). The file name itself should be in the format
117-
``<datetime>.bpo-<issue-number>.<nonce>.rst``:
117+
``<datetime>.gh-issue-<issue-number>.<nonce>.rst``:
118118

119119
* ``<datetime>`` is today's date joined with a hyphen (``-``) to the current
120120
time, in the ``YYYY-MM-DD-hh-mm-ss`` format (e.g. ``2017-05-27-16-46-23``).
121121
* ``<issue-number>`` is the issue number the change is for (e.g. ``12345``
122-
for ``bpo-12345``).
122+
for ``gh-issue-12345``).
123123
* ``<nonce>`` is a unique string to guarantee that the file name is
124124
unique across branches (e.g. ``Yl4gI2``). It is typically six characters
125125
long, but it can be any length of letters and numbers. Its uniqueness
126126
can be satisfied by typing random characters on your keyboard.
127127

128128
As a result, a file name can look something like
129-
``Misc/NEWS.d/next/Library/2017-05-27-16-46-23.bpo-12345.Yl4gI2.rst``.
129+
``Misc/NEWS.d/next/Library/2017-05-27-16-46-23.gh-issue-12345.Yl4gI2.rst``.
130130

131131
The contents of a ``NEWS`` file should be valid reStructuredText. An 80 character
132132
column width should be used. There is no indentation or leading marker in the
@@ -216,8 +216,10 @@ hashes and their first line of the commit, use the following command::
216216
You can prefix the backport pull request with the branch, and reference
217217
the pull request number from ``main``. Here is an example::
218218

219-
[3.9] bpo-12345: Fix the Spam Module (GH-NNNN)
219+
[3.9] gh-12345: Fix the Spam Module (GH-NNNN)
220220

221+
Here "gh-12345" is the GitHub *issue* number, and "GH-NNNN" is the
222+
number of the original *pull request*.
221223
Note that cherry_picker.py_ adds the branch prefix automatically.
222224

223225
Once the backport pull request has been created, remove the
@@ -242,9 +244,9 @@ Always include the reason for reverting the commit to help others
242244
understand why it was done. The reason should be included as part of
243245
the commit message. Here is an example::
244246

245-
Revert bpo-NNNN: Fix Spam Module (GH-111)
247+
Revert gh-NNNN: Fix Spam Module (GH-111)
246248

247249
Reverts python/cpython#111.
248250
Reason: This commit broke the buildbot.
249251

250-
.. _issue tracker: https://github.com/python/cpython/issues
252+
.. _issue tracker: https://github.com/python/cpython/issues

gitbootcamp.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Staging and Committing Files
200200

201201
.. code-block:: bash
202202
203-
git commit -m "bpo-XXXX: This is the commit message."
203+
git commit -m "gh-XXXX: This is the commit message."
204204
205205
Reverting Changes
206206
-----------------
@@ -441,14 +441,14 @@ Pull requests can be accepted and merged by a Python Core Developer.
441441

442442
Example of good commit message::
443443

444-
bpo-12345: Improve the spam module (GH-777)
444+
gh-12345: Improve the spam module (GH-777)
445445

446446
* Add method A to the spam module
447447
* Update the documentation of the spam module
448448

449449
Example of bad commit message::
450450

451-
bpo-12345: Improve the spam module (#777)
451+
gh-12345: Improve the spam module (#777)
452452

453453
* Improve the spam module
454454
* merge from main
@@ -487,17 +487,17 @@ commands:
487487
.. code-block:: bash
488488
489489
git fetch upstream
490-
git rev-parse ":/bpo-12345"
490+
git rev-parse ":/gh-12345"
491491
492492
The above commands will print out the hash of the commit containing
493-
``"bpo-12345"`` as part of the commit message.
493+
``"gh-12345"`` as part of the commit message.
494494

495495
When formatting the commit message for a backport commit: leave the original
496496
one as is and delete the number of the backport pull request.
497497

498498
Example of good backport commit message::
499499

500-
bpo-12345: Improve the spam module (GH-777)
500+
gh-12345: Improve the spam module (GH-777)
501501

502502
* Add method A to the spam module
503503
* Update the documentation of the spam module
@@ -506,7 +506,7 @@ Example of good backport commit message::
506506

507507
Example of bad backport commit message::
508508

509-
bpo-12345: Improve the spam module (GH-777) (#888)
509+
gh-12345: Improve the spam module (GH-777) (#888)
510510

511511
* Add method A to the spam module
512512
* Update the documentation of the spam module

index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ instructions please see the :ref:`setup guide <setup>`.
6161
everything is ok, commit.
6262

6363
7. Push the branch on your fork on GitHub and :doc:`create a pull request
64-
<pullrequest>`. Include the issue number using ``bpo-NNNN`` in the
64+
<pullrequest>`. Include the issue number using ``gh-NNNN`` in the
6565
pull request description. For example::
6666

67-
bpo-12345: Fix some bug in spam module
67+
gh-12345: Fix some bug in spam module
6868

6969
8. Add a News entry into the ``Misc/NEWS.d`` directory as individual file. The
7070
news entry can be created by using `blurb-it <https://blurb-it.herokuapp.com/>`_,

pullrequest.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ and for each pull request there may be several commits. In particular:
268268

269269
Commit messages should follow the following structure::
270270

271-
bpo-42: Make the spam module more spammy (GH-NNNN)
271+
gh-42: Make the spam module more spammy (GH-NNNN)
272272

273273
The spam module sporadically came up short on spam. This change
274274
raises the amount of spam in the module by making it more spammy.
@@ -346,7 +346,7 @@ Now you want to
346346
<https://help.github.com/articles/creating-a-pull-request-from-a-fork/>`_.
347347
If this is a pull request in response to a pre-existing issue on the
348348
`issue tracker`_, please make sure to reference the issue number using
349-
``bpo-NNNN`` in the pull request title or message.
349+
``gh-NNNN`` in the pull request title or message.
350350

351351
If this is a pull request for an unreported issue (assuming you already
352352
performed a search on the issue tracker for a pre-existing issue), create a
@@ -498,4 +498,4 @@ often, in a contribution's news entry as well). You may be
498498
asked to make these edits on the behalf of the core developer who
499499
accepts your pull request.
500500

501-
.. _issue tracker: https://github.com/python/cpython/issues
501+
.. _issue tracker: https://github.com/python/cpython/issues

0 commit comments

Comments
 (0)