Skip to content

Commit 20bf4b6

Browse files
committed
Go over CONTRIBUTING.md
1 parent d528dd4 commit 20bf4b6

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

.github/CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ The official tag is `python-attrs` and helping out in support frees us up to imp
3030
This is a hard rule; patches with missing tests or documentation can't be merged.
3131
- Make sure your changes pass our [CI].
3232
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`.
3336
- Once you've addressed review feedback, make sure to bump the pull request with a short note, so we know you're done.
3437
- Don’t break backwards compatibility.
3538

@@ -120,27 +123,27 @@ You don't need to install *towncrier* yourself, you just have to abide by a few
120123
- Wrap arguments into asterisks like in docstrings:
121124
`Added new argument *an_argument*.`
122125
- 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()`.
124127
This makes the changelog a lot more readable.
125128
- Prefer simple past tense or constructions with "now".
126129
For example:
127130

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.
130133
- If you want to reference multiple issues, copy the news fragment to another filename.
131134
*towncrier* will merge all news fragments with identical contents into one entry with multiple links to the respective pull requests.
132135

133136
Example entries:
134137

135138
```rst
136-
Added ``attr.validators.func()``.
139+
Added ``attrs.validators.func()``.
137140
The feature really *is* awesome.
138141
```
139142

140143
or:
141144

142145
```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.
144147
The bug really *was* nasty.
145148
```
146149

0 commit comments

Comments
 (0)