CONTRIBUTING.md

Contributing

Setting up the environment

npm i
npm run build

This will install all the required dependencies and build output in lib/.

Adding and running examples

You can run, modify and add new examples in examples/ directory.

cd examples/
npm i
npm run tsn <example>.ts

Linting and formatting

This repository uses prettier and eslint to format the code in the repository.

npm run lint
npm run format

Testing

This repository uses jest to test.

npm test

Publishing and release

You need run scripts/publish-npm script with an NPM_TOKEN set on environment after change version of package in package.json.

npm i
chmod +x scripts/publish-npm
./scripts/publish-npm