Skip to content

Commit bde33a3

Browse files
committed
Update CONTRIBUTING.md
1 parent cca9938 commit bde33a3

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ All contributors are expected to follow the [Rust Code of Conduct].
2323
- [Issue and PR triage](#issue-and-pr-triage)
2424
- [Bors and Homu](#bors-and-homu)
2525
- [Contributions](#contributions)
26+
- [License](#license)
2627

2728
[Zulip]: https://rust-lang.zulipchat.com/#narrow/stream/clippy
2829
[Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct
@@ -245,6 +246,38 @@ Contributions to Clippy should be made in the form of GitHub pull requests. Each
245246
be reviewed by a core contributor (someone with permission to land patches) and either landed in the
246247
main tree or given feedback for changes that would be required.
247248

249+
All PRs should include a `changelog` entry with a short comment explaining the change. The rule of thumb is basically,
250+
"what do you believe is important from an outsider's perspective?" Often, PRs are only related to a single property of a
251+
lint, and then it's good to mention that one. Otherwise, it's better to include too much detail than too little.
252+
253+
Clippy's [changelog] is created from these comments. Every release, someone gets all commits from bors with a
254+
`changelog: XYZ` entry and combines them into the changelog. This is a manual process.
255+
256+
Examples:
257+
- New lint
258+
```
259+
changelog: new lint: [`missing_trait_methods`]
260+
```
261+
- False positive fix
262+
```
263+
changelog: Fix [`unused_peekable`] false positive when peeked in a closure or called as `f(&mut peekable)`
264+
```
265+
- Purely internal change
266+
```
267+
changelog: none
268+
```
269+
270+
Note this it is fine for a PR to include multiple `changelog` entries, e.g.:
271+
```
272+
changelog: Something 1
273+
changelog: Something 2
274+
changelog: Something 3
275+
```
276+
277+
[changelog]: CHANGELOG.md
278+
279+
## License
280+
248281
All code in this repository is under the [Apache-2.0] or the [MIT] license.
249282

250283
<!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->

0 commit comments

Comments
 (0)