Skip to content

Commit 971a621

Browse files
committed
Add pull request template
1 parent 51e414e commit 971a621

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Pull Request Check List
2+
3+
This is just a friendly reminder about the most common mistakes. Please make sure that you tick all boxes. But please read our [contribution guide](https://www.structlog.org/en/latest/contributing.html) at least once, it will save you unnecessary review cycles!
4+
5+
If an item doesn't apply to your pull request, **check it anyway** to make it apparent that there's nothing left to do.
6+
7+
- [ ] Added **tests** for changed code.
8+
- [ ] Updated **documentation** for changed code.
9+
- [ ] New functions/classes have to be added to `docs/api.rst` by hand.
10+
- [ ] Changed/added classes/methods/functions have appropriate `versionadded`, `versionchanged`, or `deprecated` [directives](http://www.sphinx-doc.org/en/stable/markup/para.html#directive-versionadded). Find the appropriate next version in our [``__init__.py``](https://github.com/hynek/structlog/blob/master/src/structlog/__init__.py) file.
11+
- [ ] Documentation in `.rst` files is written using [semantic newlines](https://rhodesmill.org/brandon/2012/one-sentence-per-line/).
12+
- [ ] Changes (and possible deprecations) are documented in the [changelog](https://github.com/hynek/structlog/blob/master/CHANGELOG.rst).
13+
14+
If you have *any* questions to *any* of the points above, just **submit and ask**! This checklist is here to *help* you, not to deter you from contributing!

0 commit comments

Comments
 (0)