diff options
| author | Laurențiu Nicola <lnicola@dend.ro> | 2021-04-19 21:09:24 +0300 |
|---|---|---|
| committer | Laurențiu Nicola <lnicola@dend.ro> | 2021-04-19 21:30:44 +0300 |
| commit | bb4952da042ed5f6bffe2b362de053b4240deb21 (patch) | |
| tree | 22fd86dd97d98fcd15d8194182ed12a6e02ec60f /docs/dev/style.md | |
| parent | 6991b517f2c1ba9eb75f98ca689378e8dfa1e87f (diff) | |
| download | rust-bb4952da042ed5f6bffe2b362de053b4240deb21.tar.gz rust-bb4952da042ed5f6bffe2b362de053b4240deb21.zip | |
internal: Add guidelines for release notes PR descriptions
Diffstat (limited to 'docs/dev/style.md')
| -rw-r--r-- | docs/dev/style.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/dev/style.md b/docs/dev/style.md index 078c478d41b..6ab60b50ed7 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md @@ -83,8 +83,19 @@ This makes it easier to prepare a changelog. If the change adds a new user-visible functionality, consider recording a GIF with [peek](https://github.com/phw/peek) and pasting it into the PR description. +To make writing the release notes easier, you can mark a pull request as a feature, fix, internal change, or minor. +Minor changes are excluded from the release notes, while the other types are distributed in their corresponding sections. +There are two ways to mark this: + +* use a `feat: `, `feature: `, `fix: `, `internal: ` or `minor: ` prefix in the PR title +* write `changelog [feature|fix|internal|skip] [description]` in a comment or in the PR description; the description is optional, and will replace the title if included. + +These comments don't have to be added by the PR author. +Editing a comment or the PR description or title is also fine, as long as it happens before the release. + **Rationale:** clean history is potentially useful, but rarely used. But many users read changelogs. +Including a description and GIF suitable for the changelog means less work for the maintainers on the release day. ## Clippy |
