mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Further text improvements

Browse Source
This commit is contained in:
Philipp Hansch 2019-08-12 19:19:46 +02:00
parent c90eb4f4b3
commit 38c1971b43
No known key found for this signature in database
GPG Key ID: 82AA61CAA11397E6
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/changelog_update.md
View File

@ -4,9 +4,12 @@ If you want to help with updating the [changelog][changelog], you're in the righ
## When to update ## When to update
The changelog is ideally updated during the week before an upcoming stable Typos and other small fixes/additions are _always_ welcome.
release. Typos and other small fixes/additions are always welcome. You can find
the release dates on the [Rust Forge][forge]. 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 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. been very rare that Clippy changes were included in a patch release.
@ -42,7 +45,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 more irrelevant PRs. If you're not sure about some PRs, just leave them in for
the review and ask for feedback. 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 `changelog: ` content to `CHANGELOG.md`. Adapt the wording as you see fit but
try to keep it somewhat coherent. try to keep it somewhat coherent.
@ -54,6 +57,9 @@ The order should roughly be:
4. False positive fixes 4. False positive fixes
5. Suggestion fixes/improvements 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 [changelog]: https://github.com/rust-lang/rust-clippy/blob/master/CHANGELOG.md
[forge]: https://forge.rust-lang.org/ [forge]: https://forge.rust-lang.org/
[tools]: https://github.com/rust-lang/rust/tree/master/src/tools [tools]: https://github.com/rust-lang/rust/tree/master/src/tools