Auto merge of #5156 - flip1995:dev_add_internal, r=phansch

[rust.git] / doc / changelog_update.md

diff --git a/doc/changelog_update.md b/doc/changelog_update.md
index b54143e23574f7de24866000a906106507a308b8..cabf25135dacf7bb0e71a5df2375c77dbe81ae41 100644 (file)
--- a/doc/changelog_update.md
+++ b/doc/changelog_update.md
@@ -4,9 +4,12 @@ If you want to help with updating the [changelog][changelog], you're in the righ
 
 ## When to update
 
-The changelog is ideally updated during the week before an upcoming stable
-release. Typos and other small fixes/additions are always welcome. You can find
-the release dates on the [Rust Forge][forge].
+Typos and other small fixes/additions are _always_ welcome.
+
+Special care needs to be taken when it comes to updating the changelog for a new
+Rust release. For that purpose, the changelog is ideally updated during the week
+before an upcoming stable release. You can find the release dates on the [Rust
+Forge][forge].
 
 Most of the time we only need to update the changelog for minor Rust releases. It's
 been very rare that Clippy changes were included in a patch release.
@@ -21,7 +24,10 @@ be found in the [tools][tools] directory of the Rust repository.
 To find the Clippy commit hash for a specific Rust release you select the Rust
 release tag from the dropdown and then check the commit of the Clippy directory:
 
-TODO: Include screenshot
+![Explanation of how to find the commit hash](https://user-images.githubusercontent.com/2042399/62846160-1f8b0480-bcce-11e9-9da8-7964ca034e7a.png)
+
+When writing the release notes for the upcoming stable release you want to check
+out the commit of the current Rust `beta` tag.
 
 ### 2. Fetching the PRs between those commits
 
@@ -42,7 +48,7 @@ already, but it's a good idea to do a manual cleanup pass where you look for
 more irrelevant PRs. If you're not sure about some PRs, just leave them in for
 the review and ask for feedback.
 
-With PRs filtered, you can start to take each PR and move the
+With the PRs filtered, you can start to take each PR and move the
 `changelog: ` content to `CHANGELOG.md`. Adapt the wording as you see fit but
 try to keep it somewhat coherent.
 
@@ -54,6 +60,9 @@ The order should roughly be:
 4. False positive fixes
 5. Suggestion fixes/improvements
 
+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/
 [tools]: https://github.com/rust-lang/rust/tree/master/src/tools