Skip to content

Commit a3edc04

Browse files
committed
Add more detailed change log instructions
[skip ci]
1 parent 8dee032 commit a3edc04

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ and then run `npm start` or `npm run build`.
6767
5. Create a change log entry for the release:
6868
* You'll need an [access token for the GitHub API](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). Save it to this environment variable: `export GITHUB_AUTH="..."`
6969
* Run `npm run changelog`. The command will find all the labeled pull requests merged since the last release and group them by the label and affected packages, and create a change log entry with all the changes and links to PRs and their authors. Copy and paste it to `CHANGELOG.md`.
70-
* Edit the change log as necessary. Don't forget to document any breaking changes!
70+
* Add a four-space indented paragraph after each non-trivial list item, explaining what changed and why. For each breaking change also write who it affects and instructions for migrating existing code.
7171
6. Make sure to include “Migrating from ...” instructions for the previous release. Often you can copy and paste them.
7272
7. After merging the changelog update, create a GitHub Release with the same text. See previous Releases for inspiration.
7373
8. **Do not run `npm publish`. Instead, run `npm run publish`.**

0 commit comments

Comments
 (0)