Add a simple CONTRIBUTING.md

This commit is contained in:
Benoit Daloze
2020-03-10 11:34:03 +01:00
parent 80b79ff73f
commit cfe5daad50
+21
View File
@@ -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
```