Skip to content

Commit dd3fc1e

Browse files
committed
Added the pull request template
1 parent 4ede387 commit dd3fc1e

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!-- Thank you for your contribution! -->
2+
## Changes
3+
4+
Fixes #. <!-- Provide issue number if exists -->
5+
6+
<!-- Please give a short brief about these changes. -->
7+
8+
## Checklist
9+
10+
If this is a user-facing code change, like a bugfix or a new feature, please ensure that
11+
you've fulfilled the following conditions (where applicable):
12+
13+
- [ ] You've added tests (in `tests/`) added which would fail without your patch
14+
- [ ] You've updated the documentation (in `docs/`, in case of behavior changes or new
15+
features)
16+
- [ ] You've added a new changelog entry (in `docs/versionhistory.rst`).
17+
18+
If this is a trivial change, like a typo fix or a code reformatting, then you can ignore
19+
these instructions.
20+
21+
### Updating the changelog
22+
23+
If there are no entries after the last release, use `**UNRELEASED**` as the version.
24+
If, say, your patch fixes issue #999, the entry should look like this:
25+
26+
`* Fix big bad boo-boo in the pytest plugin (#999
27+
<https://github.com/agronholm/typeguard/issues/999>_; PR by @yourgithubaccount)`
28+
29+
If there's no issue linked, just link to your pull request instead by updating the
30+
changelog after you've created the PR.

0 commit comments

Comments
 (0)