2021-11-25 05:11:50 +00:00
# Summary
2021-12-16 08:25:22 +00:00
<!-- Please tell us what your pull request is about here. -->
2021-11-25 05:11:50 +00:00
2017-03-24 08:34:51 +00:00
# Pull Request Check List
2021-12-16 08:25:22 +00:00
<!--
2021-12-16 07:28:19 +00:00
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 ](https://github.com/python-attrs/attrs/blob/main/.github/CONTRIBUTING.md ) at least once, it will save you unnecessary review cycles!
2017-03-24 08:34:51 +00:00
2021-12-16 07:28:19 +00:00
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.
2021-12-16 08:25:22 +00:00
-->
2018-10-08 08:59:05 +00:00
2017-03-24 08:34:51 +00:00
- [ ] Added **tests** for changed code.
2021-12-16 07:28:19 +00:00
Our CI fails if coverage is not 100%.
2021-02-25 07:46:28 +00:00
- [ ] New features have been added to our [Hypothesis testing strategy ](https://github.com/python-attrs/attrs/blob/main/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` .
2021-12-25 14:15:10 +00:00
- [ ] If they've been added to `attr/__init__.pyi` , they've *also* been re-imported in `attrs/__init__.pyi` .
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.
2018-10-08 08:59:05 +00:00
- [ ] Changes to the signature of `@attr.s()` have to be added by hand too.
2021-12-16 07:28:19 +00:00
- [ ] Changed/added classes/methods/functions have appropriate `versionadded` , `versionchanged` , or `deprecated` [directives ](http://www.sphinx-doc.org/en/stable/markup/para.html#directive-versionadded ).
Find the appropriate next version in our [``__init__.py`` ](https://github.com/python-attrs/attrs/blob/main/src/attr/__init__.py ) file.
2019-03-03 08:25:58 +00:00
- [ ] Documentation in `.rst` files is written using [semantic newlines ](https://rhodesmill.org/brandon/2012/one-sentence-per-line/ ).
2021-02-25 07:46:28 +00:00
- [ ] Changes (and possible deprecations) have news fragments in [`changelog.d` ](https://github.com/python-attrs/attrs/blob/main/changelog.d ).
2022-01-29 14:27:56 +00:00
- [ ] Consider granting [push permissions to the PR branch ](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork ), so maintainers can fix minor issues themselves without pestering you.
2017-03-24 08:34:51 +00:00
2021-12-16 08:25:22 +00:00
<!--
2021-12-16 07:28:19 +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!
2021-12-16 08:25:22 +00:00
-->
