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

Commit 9c9d16a

Browse files
committed
Docs: update publishing info
1 parent 91cc6d6 commit 9c9d16a

1 file changed

Lines changed: 5 additions & 10 deletions

File tree

MAINTAIN.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -97,16 +97,11 @@ Publishing a new version
9797
---------------------------
9898

9999
1. Determine which part of the version you are about to increase. See our strategy in OVERVIEW.md.
100-
1. Write changes to `CHANGELOG.md`: `npm run changelog`.
101-
Clean up the changelog by manually clarifying and reordering the messages. Ensure the changes are listed in following order:
102-
1. breaking changes.
103-
1. preset updates.
104-
1. new CLI or config options.
105-
1. new rules or rule values.
106-
1. bug fixes.
107-
1. infrastructure changes.
108-
1. tests-only, docs changes, contributor minutia.
109-
1. Commit the changelog update with the message: `Prepare for version x.x.x`.
100+
1. Check out the [previous releases](https://github.com/jscs-dev/node-jscs/releases) for how we write our changelogs. We tend to write out a summary at the beginning and explanatory paragraphs for anything that needs further clairification.
101+
1. Use `npm run changelog` to get a gist of the changes. Use these to determine what should be included in the changelog.
102+
1. Some categories we use: New Rules, New Rule Options, Bug Fixes, Internal Changes, Preset Updates, CLI/Config changes.
103+
1. Write changes to `CHANGELOG.md`.
104+
1. Commit the changelog update with the message: `Misc: add x.x.x changelog`.
110105
1. Set a new version and tag: `npm version x.x.x`.
111106
1. Push changes and tags: `git push && git push --tags`.
112107
1. Use `npm run release` to publish the new version to npm. **DO NOT USE `npm publish`**, as this will not perform the necessary prepublish tasks. If you don't have publish privileges, ask @mdevils to publish for you.

0 commit comments

Comments
 (0)