CONTRIBUTING.md

Contributing

Publishing a release

Preparing a release:

1. Increase version number in package.json.
2. Run npm install in order to update package-lock.json with the right version number.
3. Update Changelog.
   1. Set current version number to Unreleased section.
   2. Remove empty entries.
   3. Add link to compare changes with previous release.
   4. Set current version number to CLI getOptions

Creating the release:

1. Draft a new release
   1. Create a new tag by prefixing the version number by the letter v. Some good tag names might be v1.0.0 or v2.3.4.
   2. Use version number as the release title.
   3. Use changelog as the release description.
2. Publish release.
3. Add Unreleased section to the Changelog.

The GitHub action Publish Package to npmjs will automatically publish release to npm.

Semantic Versioning

Based on Semantic Versioning, given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version when you make incompatible API changes.
• MINOR version when you add functionality in a backwards compatible manner.
• PATCH version when you make backwards compatible bug fixes.