2017-03-24 08:34:51 +00:00
# Pull Request Check List
2018-08-20 04:47:37 +00:00
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://www.attrs.org/en/latest/contributing.html ) at least once, it will save you unnecessary review cycles!
2017-03-24 08:34:51 +00:00
- [ ] Added **tests** for changed code.
2018-04-10 22:00:57 +00:00
- [ ] New features have been added to our [Hypothesis testing strategy ](https://github.com/python-attrs/attrs/blob/master/tests/strategies.py ).
2018-07-14 11:32:49 +00:00
- [ ] Changes or additions to public APIs are reflected in our type stubs (files ending in ``.pyi``).
2018-08-21 05:46:20 +00:00
- [ ] ...and used in the stub test file `tests/typing_example.py` .
2017-03-24 08:34:51 +00:00
- [ ] Updated **documentation** for changed code.
2018-08-21 05:46:20 +00:00
- [ ] New functions/classes have to be added to `docs/api.rst` by hand.
- [ ] Changed/added classes/methods/functions have appropriate `versionadded` , `versionchanged` , or `deprecated` [directives ](http://www.sphinx-doc.org/en/stable/markup/para.html#directive-versionadded ).
2017-03-24 08:34:51 +00:00
- [ ] Documentation in `.rst` files is written using [semantic newlines ](http://rhodesmill.org/brandon/2012/one-sentence-per-line/ ).
2017-08-20 05:58:08 +00:00
- [ ] Changes (and possible deprecations) have news fragments in [`changelog.d` ](https://github.com/python-attrs/attrs/blob/master/changelog.d ).
2017-03-24 08:34:51 +00:00
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!
