You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,19 +5,25 @@ Please tell us what your pull request is about here.
5
5
6
6
# Pull Request Check List
7
7
8
-
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!
8
+
This is just a friendly reminder about the most common mistakes.
9
+
Please make sure that you tick all boxes.
10
+
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!
9
11
10
-
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.
12
+
If an item doesn't apply to your pull request, **check it anyway** to make it apparent that there's nothing left to do.
13
+
If your pull request is a documentation fix or a trivial typo, feel free to delete the whole thing.
11
14
12
15
-[ ] Added **tests** for changed code.
16
+
Our CI fails if coverage is not 100%.
13
17
-[ ] New features have been added to our [Hypothesis testing strategy](https://github.com/python-attrs/attrs/blob/main/tests/strategies.py).
14
18
-[ ] Changes or additions to public APIs are reflected in our type stubs (files ending in ``.pyi``).
15
19
-[ ] ...and used in the stub test file `tests/typing_example.py`.
16
20
-[ ] Updated **documentation** for changed code.
17
21
-[ ] New functions/classes have to be added to `docs/api.rst` by hand.
18
22
-[ ] Changes to the signature of `@attr.s()` have to be added by hand too.
19
-
-[ ] 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.
23
+
-[ ] Changed/added classes/methods/functions have appropriate `versionadded`, `versionchanged`, or `deprecated`[directives](http://www.sphinx-doc.org/en/stable/markup/para.html#directive-versionadded).
24
+
Find the appropriate next version in our [``__init__.py``](https://github.com/python-attrs/attrs/blob/main/src/attr/__init__.py) file.
20
25
-[ ] Documentation in `.rst` files is written using [semantic newlines](https://rhodesmill.org/brandon/2012/one-sentence-per-line/).
21
26
-[ ] Changes (and possible deprecations) have news fragments in [`changelog.d`](https://github.com/python-attrs/attrs/blob/main/changelog.d).
22
27
23
-
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!
28
+
If you have *any* questions to *any* of the points above, just **submit and ask**!
29
+
This checklist is here to *help* you, not to deter you from contributing!
0 commit comments