1.8 KiB
1.8 KiB
Pull Request Check List
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 at least once, it will save you unnecessary review cycles!
If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing left to do. If your pull request is a documentation fix or a trivial typo, feel free to delete the whole thing.
- Added tests for changed code.
- New features have been added to our Hypothesis testing strategy.
- Changes or additions to public APIs are reflected in our type stubs (files ending in
.pyi).- ...and used in the stub test file
tests/typing_example.py.
- ...and used in the stub test file
- Updated documentation for changed code.
- New functions/classes have to be added to
docs/api.rstby hand. - Changes to the signature of
@attr.s()have to be added by hand too. - Changed/added classes/methods/functions have appropriate
versionadded,versionchanged, ordeprecateddirectives. Find the appropriate next version in our__init__.pyfile.
- New functions/classes have to be added to
- Documentation in
.rstfiles is written using semantic newlines. - Changes (and possible deprecations) have news fragments in
changelog.d.
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!