Replace this text with a high-level summary of the changes included in this PR.
Please reference here any issue #'s that are relevant to this PR, or simply enter "N/A" if this PR does not relate to any existing issues.
This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. Reading our contribution guide at least once will save you a few review cycles!
If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.
- Applied changes to both WSGI and ASGI code paths and interfaces (where applicable).
- Added tests for changed code.
- Performed automated tests and code quality checks by running
tox. - Prefixed code comments with GitHub nick and an appropriate prefix.
- Coding style is consistent with the rest of the framework.
- Updated documentation for changed code.
- Added docstrings for any new classes, functions, or modules.
- Updated docstrings for any modifications to existing code.
- Updated both WSGI and ASGI docs (where applicable).
- Added references to new classes, functions, or modules to the relevant RST file under
docs/. - Updated all relevant supporting documentation files under
docs/. - A copyright notice is included at the top of any new modules (using your own name or the name of your organization).
- Changed/added classes/methods/functions have appropriate
versionadded,versionchanged, ordeprecateddirectives.
- Changes (and possible deprecations) have towncrier news fragments under
docs/_newsfragments/, with the file name format{issue_number}.{fragment_type}.rst. (Runtowncrier --draftto ensure it renders correctly.)
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!
PR template inspired by the attrs project.