- Check issues
- Write documentation
- Write tests
- Fix bugs
- Refactor code
- Add new features as needed
- Should have a human-readable change log update under an
Unreleased
heading - Be wary of breaking changes -- WWSVD? (Would Would SemVer Do?)
- New functions should have tests and doc (using jsdoc)
- All tests should pass
- Only merge to master if it's ready to go out with the next release
- All patch and minor updates are fine to merge to master
- Major updates (breaking changes) should be merged to a separate major branch
- Use
[DNM]
(Do Not Merge) in the PR title to indicate more changes are pending
- Is this a patch, minor, or major release?
- Are all tests passing?
- Is the change log up to date?
- One commit should handle the version bump
- Commit message format:
:package: X.Y.Z
- Bump in
package.json
andCHANGELOG.md
- Version number in
CHANGELOG.md
should have a compare link for diff from last version
- Create a release on github using
gh-release
- Verify that everything looks okay (you can undo a release on github, but not on npm)
- Run
npm run compile
- Run
npm publish