summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2018-05-15 11:58:30 -0400
committerGitHub <noreply@github.com>2018-05-15 11:58:30 -0400
commit69ea148f1741ea3a55f71606d29885f1df8355f3 (patch)
tree0a50181a65cfcf91a13c5d8d99a7dc77ff539b0f
parent4e43bc474b3013cf6ba37c00ed78d3343fde6a4d (diff)
parenta72e9970d4ebf279e8bc29f3083ef2f991530d68 (diff)
downloadpython-setuptools-git-69ea148f1741ea3a55f71606d29885f1df8355f3.tar.gz
Merge pull request #1363 from Zelgius/pull_request_template
Pull request template
-rw-r--r--.github/pull_request_template.md12
-rw-r--r--changelog.d/1355.misc.rst1
-rw-r--r--docs/developer-guide.txt4
3 files changed, 15 insertions, 2 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..aa550807
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,12 @@
+<!-- First time contributors: Take a moment to review https://setuptools.readthedocs.io/en/latest/developer-guide.html! -->
+<!-- Remove sections if not applicable -->
+
+## Summary of changes
+
+<!-- Summary goes here -->
+
+Closes <!-- issue number here -->
+
+### Pull Request Checklist
+- [ ] Changes have tests
+- [ ] News fragment added in changelog.d. See [documentation](http://setuptools.readthedocs.io/en/latest/developer-guide.html#making-a-pull-request) for details
diff --git a/changelog.d/1355.misc.rst b/changelog.d/1355.misc.rst
new file mode 100644
index 00000000..af1e3f3f
--- /dev/null
+++ b/changelog.d/1355.misc.rst
@@ -0,0 +1 @@
+Add PR template.
diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt
index ea1034ab..6b04603b 100644
--- a/docs/developer-guide.txt
+++ b/docs/developer-guide.txt
@@ -62,8 +62,8 @@ Making a pull request
---------------------
When making a pull request, please include a short summary of the changes
-and a reference to any issue tickets that the PR is intended to solve. All
-PRs with code changes should include tests. All changes should include a
+and a reference to any issue tickets that the PR is intended to solve.
+All PRs with code changes should include tests. All changes should include a
changelog entry.
``setuptools`` uses `towncrier <https://town-crier.readthedocs.io/en/latest/>`_