From bb4952da042ed5f6bffe2b362de053b4240deb21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lauren=C8=9Biu=20Nicola?= Date: Mon, 19 Apr 2021 21:09:24 +0300 Subject: internal: Add guidelines for release notes PR descriptions --- docs/dev/style.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'docs/dev') diff --git a/docs/dev/style.md b/docs/dev/style.md index 078c478d4..6ab60b50e 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 -- cgit v1.2.3