diff options
| author | flip1995 <philipp.krones@embecosm.com> | 2020-11-19 11:23:59 +0100 |
|---|---|---|
| committer | flip1995 <philipp.krones@embecosm.com> | 2020-11-19 11:23:59 +0100 |
| commit | e9afdf074090d24f18ecc9d7bb3b20861615794a (patch) | |
| tree | 1d40590e3c4e9c4cd07f7a00bd2dbfb26fc35195 | |
| parent | a98acdba3e1e1697bdde26584972893edcdc49d1 (diff) | |
| download | rust-e9afdf074090d24f18ecc9d7bb3b20861615794a.tar.gz rust-e9afdf074090d24f18ecc9d7bb3b20861615794a.zip | |
Improve changlog update documentation
| -rw-r--r-- | doc/changelog_update.md | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/changelog_update.md b/doc/changelog_update.md index 49726464957..115848c4804 100644 --- a/doc/changelog_update.md +++ b/doc/changelog_update.md @@ -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: ``` @@ -71,6 +74,19 @@ 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. @@ -78,3 +94,4 @@ relevant commit ranges. [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 |