diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c8b72fc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +## Installing dependencies + +```bash +yarn +``` + +`npm` doesn't install the correct dependencies for `eslint` so we use `yarn`. + +## Regenerating dist/index.js + +```bash +yarn run package +``` + +It is recommended to add this as a `git` `pre-commit` hook: + +```bash +cp pre-commit .git/hooks/pre-commit +```