Skip to content
This repository was archived by the owner on Mar 23, 2024. It is now read-only.

Commit d71abb5

Browse files
committed
DOCS: move contributing guide to correct spot and update release steps.
1 parent 3955c0b commit d71abb5

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed
File renamed without changes.

MAINTAIN.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,20 @@ Preparing for a new version
6868
For new features update minor version (and reset patch version to zero).
6969
For backwards incompatible changes you should update major version,
7070
but be sure to discuss changes with other maintainers.
71-
2. Write changes to `CHANGELOG.md`.
71+
2. Write changes to `CHANGELOG.md`: `npm run-script changelog`.
72+
Be sure to clean up the changelog so that changes are listed in following order:
73+
1. breaking changes.
74+
2. preset updates.
75+
3. new rules.
76+
4. new options.
77+
5. bug fixes.
78+
6. infrastructure or docs changes.
7279
3. Update browser-version: `npm run-script browserify`.
7380
4. Commit under message: `Prepare for version x.x.x`.
7481
5. Set a new version and tag: `npm version x.x.x`.
7582
6. Push changes and tags: `git push && git push --tags`.
76-
7. Ask @mdevils to publish new package for specified tag.
77-
8. Done!
83+
7. Temporarily remove (but do not commit) the notice in README.md about the docs being the "development version".
84+
8. Ask @mdevils to publish new package for specified tag, or use `npm publish` if you have privileges.
85+
9. Add back the "development version" notice to the README.md file.
86+
10. Tweet or otherwise promote the fact that a new version has been released with a link to the changelog and npm download page.
87+
11. Done!

0 commit comments

Comments
 (0)