Skip to content

Commit 41d1469

Browse files
committed
Added the pull request template
1 parent 924181e commit 41d1469

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

.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/`) which would fail without your patch
14+
- [ ] You've added a new changelog entry (in `CHANGES.rst`).
15+
16+
If this is a trivial change, like a typo fix or a code reformatting, then you can ignore
17+
these instructions.
18+
19+
### Updating the changelog
20+
21+
If there are no entries after the last release, use `**UNRELEASED**` as the version.
22+
If, say, your patch fixes issue <span>#</span>123, the entry should look like this:
23+
24+
```
25+
- Fix big bad boo-boo in task groups
26+
(`#123 <https://github.com/agronholm/sqlacodegen/issues/123>`_; PR by @yourgithubaccount)
27+
```
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)