diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 89b2d33d8..cb9d07392 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -16,7 +16,7 @@ It is highly recommended that you run some of these tests locally by: This will increase the chances your PR will pass the required CI tests. --> -# Description +## Description -# Checklist: +## Tasks -- [ ] pre-commit checks ran successfully -- [ ] tests ran successfully -- [ ] for a public change, added a [towncrier news fragment](https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments)
`changes/..rst` +- [ ] [run `pre-commit` on your machine](https://pre-commit.com/#quick-start) +- [ ] run `pytest` on your machine +- [ ] Does this PR add new features and / or change user-facing code / API? (if not, label with `no-changelog-entry-needed`) + - [ ] write news fragment(s) in `changes/`: `echo "changed something" > changes/..rst` (see below for change types) + - [ ] update relevant docstrings and / or `docs/` page + - [ ] for any new features, add unit tests - - ``changes/.feature.rst``: new feature - - ``changes/.bugfix.rst``: bug fix - - ``changes/.doc.rst``: documentation change - - ``changes/.removal.rst``: deprecation or removal of public API - - ``changes/.general.rst``: infrastructure or miscellaneous change -
-- [ ] for a public change, updated documentation -- [ ] for any new features, unit tests were added +
news fragment change types... + +- ``changes/.feature.rst``: new feature +- ``changes/.bugfix.rst``: bug fix +- ``changes/.doc.rst``: documentation change +- ``changes/.removal.rst``: deprecation or removal of public API +- ``changes/.general.rst``: infrastructure or miscellaneous change +