CONTRIBUTING.md

Building and testing

Install the dependencies.

$ npm install

Build the typescript and package it for distribution.

$ npm run build && npm run pack

Run the tests ✔️

$ npm test

Run the tests and display only the first failing tests ✔️

$ npm run test:only-errors

Run the tests with the watch mode ✔️

$ npm run test:watch

Run the linter and fix (almost) every issue for you ✔️

$ npm run lint:all:fix

Before creating a PR

Build and quality checks

Build, lint, package and test everything.

$ npm run all

IMPORTANT: Be sure to commit the result of:

$ npm run pack

Otherwise PR checks will fail.

Release

Based on standard-version.

Define the new version

You can run npm run release:dry-run to create a dry-run, or you can directly run npm run release to create a new local release.
It will run prerelease beforehand to build and pack everything.

If the prerelease succeeded, a bump of version will happen based on the unreleased commits.
It will:

• Update the package.json version field
• Update the package-lock.json version field
• Update the CHANGELOG.md to include the release notes of the new version
• Create a local tag
• Create a commit

If everything generated seems ok for you, you can push your tag by running git push --follow-tags origin {your-branch-name}.