2.4 KiB
2.4 KiB
Summary
Pull Request Check List
- Added tests for changed code. Our CI fails if coverage is not 100%.
- 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. - If they've been added to
attr/__init__.pyi, they've also been re-imported inattrs/__init__.pyi.
- ...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. - Consider granting push permissions to the PR branch, so maintainers can fix minor issues themselves without pestering you.