You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1
Original file line number
Diff line number
Diff line change
@@ -68,6 +68,7 @@ and then run `npm start` or `npm run build`.
68
68
* 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="..."`
69
69
* 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
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.
71
+
* Maybe add some newlines here and there. Preview the result on GitHub to get a feel for it. Changelog generator output is a bit too terse for my taste, so try to make it visually pleasing and well grouped.
71
72
6. Make sure to include “Migrating from ...” instructions for the previous release. Often you can copy and paste them.
72
73
7. After merging the changelog update, create a GitHub Release with the same text. See previous Releases for inspiration.
73
74
8.**Do not run `npm publish`. Instead, run `npm run publish`.**
0 commit comments