## 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.
![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
You'll want to run `util/fetch_prs_between.sh commit1 commit2 > changes.txt`
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.
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