From 916d00c47454353d6b06f10068d39d9ae332cbc6 Mon Sep 17 00:00:00 2001 From: Rahul Kumaresan Date: Tue, 18 May 2021 21:04:00 +0530 Subject: [PATCH] fixes #502: include infromation about auto-closure of bpo isssues Feature that was included in PEP-595 to automatically close issue in the bug tracker when a PR with commit message including words like- close, closes, closed, closing, fix, fixes or fixed being used with issue number is merged is documented in the devguide. --- pullrequest.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pullrequest.rst b/pullrequest.rst index 7cb1944905..5edece9149 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -286,6 +286,11 @@ to explain in proper depth what has happened (detail should be good enough that a core developer reading the commit message understands the justification for the change). +Additionally, commit message when started with these words- +**close**, **closes**, **closed**, **closing**, **fix**, **fixes** or **fixed** +along with the issue number(bpo-NNN) like ``closes bpo-NNN: ....`` ensure +auto-closure of the issue in bug tracker as the PR containing the commit is merged. + Check :ref:`the git bootcamp ` for further instructions on how the commit message should look like when merging a pull request.