Add PULL_REQUEST_TEMPLATE.md

This commit is contained in:
Hynek Schlawack 2017-03-24 09:34:51 +01:00
parent 6509da85e1
commit 5424521708
2 changed files with 22 additions and 1 deletions

View File

@ -1,5 +1,14 @@
include *.rst *.txt LICENSE tox.ini .travis.yml docs/Makefile .coveragerc conftest.py
include LICENSE *.rst
# Don't package GitHub-specific files.
exclude *.md .travis.yml
# Tests
include tox.ini .coveragerc conftest.py dev-requirements.txt
recursive-include tests *.py
# Documentation
include docs/Makefile
recursive-include docs *.png
recursive-include docs *.py
recursive-include docs *.rst

12
PULL_REQUEST_TEMPLATE.md Normal file
View File

@ -0,0 +1,12 @@
# Pull Request Check List
This is just a reminder about the most common mistakes. Please make sure that you tick all *appropriate* boxes. But please read our [contribution guide](https://attrs.readthedocs.io/en/stable/contributing.html) at least once, it will save you unnecessary review cycles!
- [ ] Added **tests** for changed code.
- [ ] New features have been added to our [Hypothesis testing strategy](https://github.com/python-attrs/attrs/blob/master/tests/utils.py).
- [ ] Updated **documentation** for changed code.
- [ ] Documentation in `.rst` files is written using [semantic newlines](http://rhodesmill.org/brandon/2012/one-sentence-per-line/).
- [ ] Changed/added classes/methods/functions have appropriate `versionadded`, `versionchanged`, or `deprecated` [directives](http://www.sphinx-doc.org/en/stable/markup/para.html#directive-versionadded).
- [ ] Changes (and possible deprecations) are documented in [`CHANGELOG.rst`](https://github.com/python-attrs/attrs/blob/master/CHANGELOG.rst).
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!