summaryrefslogtreecommitdiff
path: root/.github/PULL_REQUEST_TEMPLATE.md
diff options
context:
space:
mode:
authorBruno Oliveira <nicoddemus@gmail.com>2018-02-06 22:13:04 -0200
committerBruno Oliveira <nicoddemus@gmail.com>2018-02-06 22:20:39 -0200
commit40d0ade2d9d0ab6d8d8b3df759945511042f86b5 (patch)
treeba5acbbdc67bb4704728de81730cb7d71f7db98c /.github/PULL_REQUEST_TEMPLATE.md
parent71527072801b6d83db168996529be1e76ce96bc4 (diff)
downloadpytest-40d0ade2d9d0ab6d8d8b3df759945511042f86b5.tar.gz
Add changelog/README.rst and streamline our PR template text
This streamlines the PR template text and adds a more in-depth explanation about how the changelog entries work because this topic is a common source of confusion: - How to name the files. - Which formatting to use (people in general assume it is Markdown). - Recommend adding `.rst` extension to changelog files to help with the above (`towncrier` doesn't care). This was heavily inspired by the excellent python-trio/trio docs.
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 690426d68..64769b8e2 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,15 +1,14 @@
Thanks for submitting a PR, your contribution is really appreciated!
-Here's a quick checklist that should be present in PRs:
+Here's a quick checklist that should be present in PRs (you can delete this text from the final description, this is
+just a guideline):
-- [ ] Add a new news fragment into the changelog folder
- * name it `$issue_id.$type` for example (588.bugfix)
- * if you don't have an issue_id change it to the pr id after creating the pr
- * ensure type is one of `removal`, `feature`, `bugfix`, `vendor`, `doc` or `trivial`
- * Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."
-- [ ] Target: for `bugfix`, `vendor`, `doc` or `trivial` fixes, target `master`; for removals or features target `features`;
-- [ ] Make sure to include reasonable tests for your change if necessary
+- [ ] Create a new changelog file into the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](/changelog/README.rst) for details.
+- [ ] Target the `master` branch for bug fixes, documentation updates and trivial changes.
+- [ ] Target the `features` branch for new features and removals/deprecations.
+- [ ] Include documentation when adding new features.
+- [ ] Include new tests or update existing tests when applicable.
-Unless your change is a trivial or a documentation fix (e.g., a typo or reword of a small section) please:
+Unless your change is trivial or a small documentation fix (e.g., a typo or reword of a small section) please:
-- [ ] Add yourself to `AUTHORS`, in alphabetical order;
+- [ ] Add yourself to `AUTHORS` in alphabetical order;