File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -622,6 +622,9 @@ The format of a correct backport commit message is:
622622
623623 (cherry picked from commit <commit_sha1>)
624624
625+ Here ``gh-XXXXX `` is the GitHub *issue * number, and ``(GH-XXXXX) `` is the
626+ original *pull request * number.
627+
625628An example of a bad backport commit message:
626629
627630.. code-block :: text
@@ -631,6 +634,17 @@ An example of a bad backport commit message:
631634
632635 * Custom message
633636
637+ .. _backport-pr :
638+
639+ The title of the backport PR must follow the same format as the commit title,
640+ beginning with the ``[<branch>] `` prefix, and referencing the original PR with
641+ a ``(GH-XXXXX) `` suffix. For example:
642+
643+ .. code-block :: text
644+ :class: good
645+
646+ [3.15] gh-12345: Fix the spam module (GH-24680)
647+
634648 After the backport PR is opened, ``miss-islington `` will link it to the original
635649PR and remove the corresponding backport label.
636650
You can’t perform that action at this time.
0 commit comments