Skip to content

Commit 15b3466

Browse files
bors[bot]lnicola
andauthored
Merge #8588
8588: internal: Add guidelines for release notes PR descriptions r=matklad a=lnicola Co-authored-by: Laurențiu Nicola <lnicola@dend.ro>
2 parents b6a7276 + bb4952d commit 15b3466

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/dev/style.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,19 @@ This makes it easier to prepare a changelog.
8383

8484
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.
8585

86+
To make writing the release notes easier, you can mark a pull request as a feature, fix, internal change, or minor.
87+
Minor changes are excluded from the release notes, while the other types are distributed in their corresponding sections.
88+
There are two ways to mark this:
89+
90+
* use a `feat: `, `feature: `, `fix: `, `internal: ` or `minor: ` prefix in the PR title
91+
* 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.
92+
93+
These comments don't have to be added by the PR author.
94+
Editing a comment or the PR description or title is also fine, as long as it happens before the release.
95+
8696
**Rationale:** clean history is potentially useful, but rarely used.
8797
But many users read changelogs.
98+
Including a description and GIF suitable for the changelog means less work for the maintainers on the release day.
8899

89100
## Clippy
90101

0 commit comments

Comments
 (0)