@@ -4,9 +4,12 @@ If you want to help with updating the [changelog][changelog], you're in the righ
4
4
5
5
## When to update
6
6
7
- The changelog is ideally updated during the week before an upcoming stable
8
- release. Typos and other small fixes/additions are always welcome. You can find
9
- the release dates on the [ Rust Forge] [ forge ] .
7
+ Typos and other small fixes/additions are _ always_ welcome.
8
+
9
+ Special care needs to be taken when it comes to updating the changelog for a new
10
+ Rust release. For that purpose, the changelog is ideally updated during the week
11
+ before an upcoming stable release. You can find the release dates on the [ Rust
12
+ Forge] [ forge ] .
10
13
11
14
Most of the time we only need to update the changelog for minor Rust releases. It's
12
15
been very rare that Clippy changes were included in a patch release.
@@ -42,7 +45,7 @@ already, but it's a good idea to do a manual cleanup pass where you look for
42
45
more irrelevant PRs. If you're not sure about some PRs, just leave them in for
43
46
the review and ask for feedback.
44
47
45
- With PRs filtered, you can start to take each PR and move the
48
+ With the PRs filtered, you can start to take each PR and move the
46
49
` changelog: ` content to ` CHANGELOG.md ` . Adapt the wording as you see fit but
47
50
try to keep it somewhat coherent.
48
51
@@ -54,6 +57,9 @@ The order should roughly be:
54
57
4 . False positive fixes
55
58
5 . Suggestion fixes/improvements
56
59
60
+ Please also be sure to update the Beta/Unreleased sections at the top with the
61
+ relevant commit ranges.
62
+
57
63
[ changelog ] : https://github.com/rust-lang/rust-clippy/blob/master/CHANGELOG.md
58
64
[ forge ] : https://forge.rust-lang.org/
59
65
[ tools ] : https://github.com/rust-lang/rust/tree/master/src/tools
0 commit comments