attrs/.github/PULL_REQUEST_TEMPLATE.md

# Summary

<!-- Please tell us what your pull request is about here. -->


# 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](https://github.com/python-attrs/attrs/blob/main/.github/CONTRIBUTING.md) 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.
  Our CI fails if coverage is not 100%.
- [ ] New features have been added to our [Hypothesis testing strategy](https://github.com/python-attrs/attrs/blob/main/tests/strategies.py).
- [ ] 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`.
- [ ] Updated **documentation** for changed code.
    - [ ] New functions/classes have to be added to `docs/api.rst` by hand.
    - [ ] Changes to the signature of `@attr.s()` have to be added by hand too.
    - [ ] 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.
- [ ] Documentation in `.rst` files is written using [semantic newlines](https://rhodesmill.org/brandon/2012/one-sentence-per-line/).
- [ ] Changes (and possible deprecations) have news fragments in [`changelog.d`](https://github.com/python-attrs/attrs/blob/main/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!
-->
Add a summary heading to avoid checklist-only PRs 2021-11-25 05:11:50 +00:00			`# Summary`

HTML-comment-out boilerplate 2021-12-16 08:25:22 +00:00			`<!-- Please tell us what your pull request is about here. -->`
Add a summary heading to avoid checklist-only PRs 2021-11-25 05:11:50 +00:00

Add PULL_REQUEST_TEMPLATE.md 2017-03-24 08:34:51 +00:00			`# Pull Request Check List`

HTML-comment-out boilerplate 2021-12-16 08:25:22 +00:00			`<!--`
Mention coverage 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!`
Add PULL_REQUEST_TEMPLATE.md 2017-03-24 08:34:51 +00:00
Mention coverage 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.`
HTML-comment-out boilerplate 2021-12-16 08:25:22 +00:00			`-->`
Update PR template - mention that attr.s() has to be updated by hand - encourage to tick boxes that do not apply 2018-10-08 08:59:05 +00:00
Add PULL_REQUEST_TEMPLATE.md 2017-03-24 08:34:51 +00:00			`- [ ] Added tests for changed code.`
Mention coverage 2021-12-16 07:28:19 +00:00			`Our CI fails if coverage is not 100%.`
Anarchy! 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).`
Add type stubs to PR checklists 2018-07-14 11:32:49 +00:00			- [ ] Changes or additions to public APIs are reflected in our type stubs (files ending in ``.pyi``).
update PR template 2018-08-21 05:46:20 +00:00			- [ ] ...and used in the stub test file `tests/typing_example.py`.
Add PULL_REQUEST_TEMPLATE.md 2017-03-24 08:34:51 +00:00			`- [ ] Updated documentation for changed code.`
update PR template 2018-08-21 05:46:20 +00:00			- [ ] New functions/classes have to be added to `docs/api.rst` by hand.
Update PR template - mention that attr.s() has to be updated by hand - encourage to tick boxes that do not apply 2018-10-08 08:59:05 +00:00			- [ ] Changes to the signature of `@attr.s()` have to be added by hand too.
Mention coverage 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.
Brandon got TLS now! 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/).
Anarchy! 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).
Add PULL_REQUEST_TEMPLATE.md 2017-03-24 08:34:51 +00:00
HTML-comment-out boilerplate 2021-12-16 08:25:22 +00:00			`<!--`
Mention coverage 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!`
HTML-comment-out boilerplate 2021-12-16 08:25:22 +00:00			`-->`