From cfe5daad50765fa670013802e61174bc415a0d4d Mon Sep 17 00:00:00 2001
From: Benoit Daloze <eregontp@gmail.com>
Date: Tue, 10 Mar 2020 11:34:03 +0100
Subject: [PATCH] Add a simple CONTRIBUTING.md

---
 CONTRIBUTING.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 CONTRIBUTING.md

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
+```