@@ -23,6 +23,7 @@ All contributors are expected to follow the [Rust Code of Conduct].
23
23
- [ Issue and PR triage] ( #issue-and-pr-triage )
24
24
- [ Bors and Homu] ( #bors-and-homu )
25
25
- [ Contributions] ( #contributions )
26
+ - [ License] ( #license )
26
27
27
28
[ Zulip ] : https://rust-lang.zulipchat.com/#narrow/stream/clippy
28
29
[ 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
245
246
be reviewed by a core contributor (someone with permission to land patches) and either landed in the
246
247
main tree or given feedback for changes that would be required.
247
248
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
+
248
281
All code in this repository is under the [ Apache-2.0] or the [ MIT] license.
249
282
250
283
<!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->
0 commit comments