From 6236a1ea3e74b6c9b84c4b98b9916de19583544a Mon Sep 17 00:00:00 2001 From: Mariatta Wijaya Date: Sat, 23 Jun 2018 22:19:06 -0700 Subject: [PATCH] Clarify that backport PR needs to include GH- from master --- committing.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/committing.rst b/committing.rst index 79c75c25f..27e43546a 100644 --- a/committing.rst +++ b/committing.rst @@ -247,7 +247,11 @@ When it is determined that a pull request needs to be backported into one or more of the maintenance branches, a core developer can apply the labels ``needs backport to X.Y`` to the pull request. -After the pull request has been merged, miss-islington (bot) will first try to do the backport automatically. In case that miss-islington is unable to do it, then the pull request author or the core developer who merged it should look into backporting it themselves, using the backport generated by cherry_picker.py_ as a starting point. +After the pull request has been merged, miss-islington (bot) will first try to +do the backport automatically. In case that miss-islington is unable to do it, +then the pull request author or the core developer who merged it should look into +backporting it themselves, using the backport generated by cherry_picker.py_ +as a starting point. The commit hash can be obtained from the original pull request, or by using ``git log`` on the ``master`` branch. @@ -256,9 +260,12 @@ message:: git log -10 --oneline -Prefix the backport pull request with the branch, for example:: +.. _backport-pr-title: - [3.7] bpo-12345: Fix the Spam Module +Prefix the backport pull request with the branch, and reference the pull request +number from ``master``, for example:: + + [3.7] bpo-12345: Fix the Spam Module (GH-NNNN) Note that cherry_picker.py_ adds the branch prefix automatically.