Skip to content

Reinstate #backport-pr-title anchor and add explicit backport PR title guidance #1855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hugovk wants to merge 3 commits into
base: main
Choose a base branch
from
+16 −0
Open

Reinstate #backport-pr-title anchor and add explicit backport PR title guidance #1855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f4ca4d
Reinstate #backport-pr-title anchor
hugovk Jul 9, 2026
dc6e0a4
Add explicit guidance for backport PR title
hugovk Jul 9, 2026
f571373
When opening..."
hugovk Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions core-team/committing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ bug fixes or security fixes. In almost all cases the fixes should first
originate on ``main`` and then be ported back to older branches.


.. _backport-pr-title:

Backporting changes to an older version
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
14 changes: 14 additions & 0 deletions getting-started/git-boot-camp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,9 @@ The format of a correct backport commit message is:

(cherry picked from commit <commit_sha1>)

Here ``gh-XXXXX`` is the GitHub *issue* number, and ``(GH-XXXXX)`` is the
original *pull request* number.

An example of a bad backport commit message:

.. code-block:: text
Expand All @@ -631,6 +634,17 @@ An example of a bad backport commit message:

* Custom message

.. _backport-pr:

When opening the backport PR, its title PR must follow the same format as the
commit title, beginning with the ``[<branch>]`` prefix and referencing the
original PR with a ``(GH-XXXXX)`` suffix. For example:

.. code-block:: text
:class: good

[3.15] gh-12345: Fix the spam module (GH-24680)

After the backport PR is opened, ``miss-islington`` will link it to the original
PR and remove the corresponding backport label.

Expand Down
Loading