Skip to content

Commit f3c93e3

Browse files
committed
Add some guidelines for change notes
1 parent 2441e6e commit f3c93e3

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

‎unreleased-change-notes/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
Change-notes are Markdown files used to document user-facing changes. When making a change that affects users, create a Markdown file here that describes the change. During the next release, the change-note files in `unreleased-change-notes/` will automatically be added to `CHANGELOG.md`.
44

5+
### What do document
6+
7+
Some guidelines to help you decide whether a change needs a change note:
8+
9+
- New functionality that is gated behind a feature flag should be documented when it is added, highlighting that the feature will only be rolled out later. Ideally, this should also include an estimate for when the feature is expected to become available.
10+
- When a feature flag is removed and the gated functionality becomes the default behaviour, this does not need to be documented.
11+
- Changes that may require users to make changes to their workflows must be documented.
12+
13+
If in doubt, see `CHANGELOG.md` for what we have included previously.
14+
515
### Change-note file format
616

717
Change-note files must follow a certain format so that they can be automatically validated and processed. Failure to follow the format will result in a failed PR check.

0 commit comments

Comments
 (0)