summaryrefslogtreecommitdiffstats
path: root/.github/PULL_REQUEST_TEMPLATE.md
diff options
context:
space:
mode:
authorMariatta <Mariatta@users.noreply.github.com>2018-02-23 23:48:21 (GMT)
committerGitHub <noreply@github.com>2018-02-23 23:48:21 (GMT)
commit82ab13d756a04eab1dae58629473b95ddf363484 (patch)
tree46132d91481d81b550729dbaffe2946a1d0be2b0 /.github/PULL_REQUEST_TEMPLATE.md
parent718070db26b35da4aedc03088c58558a833ccf6e (diff)
downloadcpython-82ab13d756a04eab1dae58629473b95ddf363484.zip
cpython-82ab13d756a04eab1dae58629473b95ddf363484.tar.gz
cpython-82ab13d756a04eab1dae58629473b95ddf363484.tar.bz2
Update the Pull_request_template.md file (GH-5841)
Changed the template to be inside a comment tag.
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md21
1 files changed, 19 insertions, 2 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 0f238d0..9040474 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,4 +1,21 @@
-!!! If this is a backport PR (PR made against branches other than `master`),
+<!--
+Thanks for your contribution!
+Please read this comment in its entirety. It's quite important.
+
+# Pull Request title
+
+It should be in the following format:
+```
+bpo-NNNN: Summary of the changes made
+```
+Where: bpo-NNNN refers to the issue number in the https://bugs.python.org.
+If your PR is for issue 12345 in the bug tracker, then the bpo number is bpo-12345.
+
+Most PRs will require an issue number. Trivial changes, like fixing a typo, do not need an issue.
+
+# Backport Pull Request title
+
+If this is a backport PR (PR made against branches other than `master`),
please ensure that the PR title is in the following format:
```
[X.Y] <title from the original PR> (GH-NNNN)
@@ -7,4 +24,4 @@ Where: [X.Y] is the branch name, e.g. [3.6].
GH-NNNN refers to the PR number from `master`.
-PLEASE: Remove this headline!!!
+-->