From dd3fc1ecda7a61d7d651f9a1cc617c89628829dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20Gr=C3=B6nholm?= Date: Sat, 25 May 2024 14:22:16 +0300 Subject: [PATCH] Added the pull request template --- .github/pull_request_template.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..3ff838d --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,30 @@ + +## Changes + +Fixes #. + + + +## Checklist + +If this is a user-facing code change, like a bugfix or a new feature, please ensure that +you've fulfilled the following conditions (where applicable): + +- [ ] You've added tests (in `tests/`) added which would fail without your patch +- [ ] You've updated the documentation (in `docs/`, in case of behavior changes or new +features) +- [ ] You've added a new changelog entry (in `docs/versionhistory.rst`). + +If this is a trivial change, like a typo fix or a code reformatting, then you can ignore +these instructions. + +### Updating the changelog + +If there are no entries after the last release, use `**UNRELEASED**` as the version. +If, say, your patch fixes issue #999, the entry should look like this: + +`* Fix big bad boo-boo in the pytest plugin (#999 +_; PR by @yourgithubaccount)` + +If there's no issue linked, just link to your pull request instead by updating the +changelog after you've created the PR.