diff --git a/core-team/committing.rst b/core-team/committing.rst index 0a5380e0f..d782e7f25 100644 --- a/core-team/committing.rst +++ b/core-team/committing.rst @@ -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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/getting-started/git-boot-camp.rst b/getting-started/git-boot-camp.rst index 95f6a94ca..4d01a851e 100644 --- a/getting-started/git-boot-camp.rst +++ b/getting-started/git-boot-camp.rst @@ -622,6 +622,9 @@ The format of a correct backport commit message is: (cherry picked from commit ) +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 @@ -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 ``[]`` 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.