Skip to content

Commit 38c1971

Browse files
committed
Further text improvements
1 parent c90eb4f commit 38c1971

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

doc/changelog_update.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@ If you want to help with updating the [changelog][changelog], you're in the righ
44

55
## When to update
66

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].
1013

1114
Most of the time we only need to update the changelog for minor Rust releases. It's
1215
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
4245
more irrelevant PRs. If you're not sure about some PRs, just leave them in for
4346
the review and ask for feedback.
4447

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
4649
`changelog: ` content to `CHANGELOG.md`. Adapt the wording as you see fit but
4750
try to keep it somewhat coherent.
4851

@@ -54,6 +57,9 @@ The order should roughly be:
5457
4. False positive fixes
5558
5. Suggestion fixes/improvements
5659

60+
Please also be sure to update the Beta/Unreleased sections at the top with the
61+
relevant commit ranges.
62+
5763
[changelog]: https://github.com/rust-lang/rust-clippy/blob/master/CHANGELOG.md
5864
[forge]: https://forge.rust-lang.org/
5965
[tools]: https://github.com/rust-lang/rust/tree/master/src/tools

0 commit comments

Comments
 (0)