CONTRIBUTING.md

Building and testing

First, you'll need to have a reasonably modern version of node handy. This won't work with versions older than 9, for instance.

Install the dependencies

$ yarn install

Build the typescript and package it for distribution

$ yarn run build && yarn run package

Run the tests

$ yarn test
...

Publishing to a distribution branch

Actions are run from GitHub repos so we will checkin the packed dist folder.

Then run ncc and push the results:

$ yarn run package
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1

Note: GitHub recommends using the --license option for ncc, which will create a license file for all of the production node modules used in your project.

The action is now published! 🚀

Also see the versioning documentation.