Skip to content

Commit

Permalink
Improve changlog update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
flip1995 committed Nov 19, 2020
1 parent a98acdb commit e9afdf0
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions doc/changelog_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@ bullet points might be helpful:
* When writing the release notes for the **upcoming beta release**, you need to check
out the Clippy commit of the current Rust `master`. [Link][rust_master_tools]
* When writing the (forgotten) release notes for a **past stable release**, you
need to select the Rust release tag from the dropdown and then check the
commit of the Clippy directory:
need to check out the Rust release tag of the stable release.
[Link][rust_stable_tools]

Usually you want to wirte the changelog of the **upcoming stable release**. Make
sure though, that `beta` was already branched in the Rust repository.

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

As section headers, we use:

```
### New Lints
### Moves and Deprecations
### Enhancements
### False Positive Fixes
### Suggestion Fixes/Improvements
### ICE Fixes
### Documentation Improvements
### Others
```

Please also be sure to update the Beta/Unreleased sections at the top with the
relevant commit ranges.

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

0 comments on commit e9afdf0

Please sign in to comment.