doc/changelog_update.md

   1 # Changelog Update
   2
   3 If you want to help with updating the [changelog][changelog], you're in the right place.
   4
   5 ## When to update
   6
   7 Typos and other small fixes/additions are _always_ welcome.
   8
   9 Special care needs to be taken when it comes to updating the changelog for a new
  10 Rust release. For that purpose, the changelog is ideally updated during the week
  11 before an upcoming stable release. You can find the release dates on the [Rust
  12 Forge][forge].
  13
  14 Most of the time we only need to update the changelog for minor Rust releases. It's
  15 been very rare that Clippy changes were included in a patch release.
  16
  17 ## Changelog update walkthrough
  18
  19 ### 1. Finding the relevant Clippy commits
  20
  21 Each Rust release ships with its own version of Clippy. The Clippy submodule can
  22 be found in the `tools` directory of the Rust repository.
  23
  24 Depending on the current time and what exactly you want to update, the following
  25 bullet points might be helpful:
  26
  27 * When writing the release notes for the **upcoming stable release** you need to check
  28   out the Clippy commit of the current Rust `beta` branch. [Link][rust_beta_tools]
  29 * When writing the release notes for the **upcoming beta release**, you need to check
  30   out the Clippy commit of the current Rust `master`. [Link][rust_master_tools]
  31 * 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:
  34
  35   ![Explanation of how to find the commit hash](https://user-images.githubusercontent.com/2042399/62846160-1f8b0480-bcce-11e9-9da8-7964ca034e7a.png)
  36
  37
  38 ### 2. Fetching the PRs between those commits
  39
  40 Once you've got the correct commit range, run
  41
  42     util/fetch_prs_between.sh commit1 commit2 > changes.txt
  43
  44 and open that file in your editor of choice.
  45
  46 When updating the changelog it's also a good idea to make sure that `commit1` is
  47 already correct in the current changelog.
  48
  49 ### 3. Authoring the final changelog
  50
  51 The above script should have dumped all the relevant PRs to the file you
  52 specified. It should have filtered out most of the irrelevant PRs
  53 already, but it's a good idea to do a manual cleanup pass where you look for
  54 more irrelevant PRs. If you're not sure about some PRs, just leave them in for
  55 the review and ask for feedback.
  56
  57 With the PRs filtered, you can start to take each PR and move the
  58 `changelog: ` content to `CHANGELOG.md`. Adapt the wording as you see fit but
  59 try to keep it somewhat coherent.
  60
  61 The order should roughly be:
  62
  63 1. New lints
  64 2. Moves or deprecations of lints
  65 3. Changes that expand what code existing lints cover
  66 4. False positive fixes
  67 5. Suggestion fixes/improvements
  68 6. ICE fixes
  69 7. Documentation improvements
  70 8. Others
  71
  72 Please also be sure to update the Beta/Unreleased sections at the top with the
  73 relevant commit ranges.
  74
  75 [changelog]: https://github.com/rust-lang/rust-clippy/blob/master/CHANGELOG.md
  76 [forge]: https://forge.rust-lang.org/
  77 [rust_master_tools]: https://github.com/rust-lang/rust/tree/master/src/tools
  78 [rust_beta_tools]: https://github.com/rust-lang/rust/tree/beta/src/tools