Skip to content

Commit e9afdf0

Browse files
committed
Improve changlog update documentation
1 parent a98acdb commit e9afdf0

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

doc/changelog_update.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,11 @@ bullet points might be helpful:
2929
* When writing the release notes for the **upcoming beta release**, you need to check
3030
out the Clippy commit of the current Rust `master`. [Link][rust_master_tools]
3131
* When writing the (forgotten) release notes for a **past stable release**, you
32-
need to select the Rust release tag from the dropdown and then check the
33-
commit of the Clippy directory:
32+
need to check out the Rust release tag of the stable release.
33+
[Link][rust_stable_tools]
34+
35+
Usually you want to wirte the changelog of the **upcoming stable release**. Make
36+
sure though, that `beta` was already branched in the Rust repository.
3437

3538
To find the commit hash, issue the following command when in a `rust-lang/rust` checkout:
3639
```
@@ -71,10 +74,24 @@ The order should roughly be:
7174
7. Documentation improvements
7275
8. Others
7376

77+
As section headers, we use:
78+
79+
```
80+
### New Lints
81+
### Moves and Deprecations
82+
### Enhancements
83+
### False Positive Fixes
84+
### Suggestion Fixes/Improvements
85+
### ICE Fixes
86+
### Documentation Improvements
87+
### Others
88+
```
89+
7490
Please also be sure to update the Beta/Unreleased sections at the top with the
7591
relevant commit ranges.
7692

7793
[changelog]: https://github.com/rust-lang/rust-clippy/blob/master/CHANGELOG.md
7894
[forge]: https://forge.rust-lang.org/
7995
[rust_master_tools]: https://github.com/rust-lang/rust/tree/master/src/tools/clippy
8096
[rust_beta_tools]: https://github.com/rust-lang/rust/tree/beta/src/tools/clippy
97+
[rust_stable_tools]: https://github.com/rust-lang/rust/releases

0 commit comments

Comments
 (0)