CONTRIBUTING.md

Development

Install all the dependencies

yarn

When running this command, a pre-commit git hook will be locally installed with husky and it will run lint-staged before every commit.

See "lint-staged" in package.json for more information.

Build the project

yarn build

Link the package to test locally

yarn link
# then if your project is in the same directory as this one
cd /path/to/your/project
yarn link ../typescript-template

Other commands

# run the entire test suite
yarn test
# format the source code
yarn format