@@ -30,6 +30,9 @@ The official tag is `python-attrs` and helping out in support frees us up to imp
30
30
This is a hard rule; patches with missing tests or documentation can't be merged.
31
31
- Make sure your changes pass our [ CI] .
32
32
You won't get any feedback until it's green unless you ask for it.
33
+ - For the CI to pass, the coverage must be 100%.
34
+ If you have problems to test something, open anyway and ask for advice.
35
+ In some situations, we may agree to add an ` # pragma: no cover ` .
33
36
- Once you've addressed review feedback, make sure to bump the pull request with a short note, so we know you're done.
34
37
- Don’t break backwards compatibility.
35
38
@@ -120,27 +123,27 @@ You don't need to install *towncrier* yourself, you just have to abide by a few
120
123
- Wrap arguments into asterisks like in docstrings:
121
124
` Added new argument *an_argument*. `
122
125
- If you mention functions or other callables, add parentheses at the end of their names:
123
- ` attr .func()` or ` attr .Class.method()` .
126
+ ` attrs .func()` or ` attrs .Class.method()` .
124
127
This makes the changelog a lot more readable.
125
128
- Prefer simple past tense or constructions with "now".
126
129
For example:
127
130
128
- + Added ` attr .validators.func()` .
129
- + ` attr .func()` now doesn't crash the Large Hadron Collider anymore when passed the * foobar* argument.
131
+ + Added ` attrs .validators.func()` .
132
+ + ` attrs .func()` now doesn't crash the Large Hadron Collider anymore when passed the * foobar* argument.
130
133
- If you want to reference multiple issues, copy the news fragment to another filename.
131
134
* towncrier* will merge all news fragments with identical contents into one entry with multiple links to the respective pull requests.
132
135
133
136
Example entries:
134
137
135
138
``` rst
136
- Added ``attr .validators.func()``.
139
+ Added ``attrs .validators.func()``.
137
140
The feature really *is* awesome.
138
141
```
139
142
140
143
or:
141
144
142
145
``` rst
143
- ``attr .func()`` now doesn't crash the Large Hadron Collider anymore when passed the *foobar* argument.
146
+ ``attrs .func()`` now doesn't crash the Large Hadron Collider anymore when passed the *foobar* argument.
144
147
The bug really *was* nasty.
145
148
```
146
149
0 commit comments