Merge pull request #798 from kit-ty-kate/contributing

Add a basic CONTRIBUTING.md file
ocaml · Jun 7, 2024 · 7bfa6a2 · 7bfa6a2
2 parents 02acf68 + 5ec1aaa
commit 7bfa6a2
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+### Developement setup
+
+Requirements:
+
+- [Node.js](https://nodejs.org)
+- [Corepack](https://nodejs.org/api/corepack.html)
+  - Shipped with Node.js, however on some distributions it is not distributed, in which case install it through npm using: `npm install --global corepack`
+
+To regenerated the compiled JavaScript files in `dist/`, call:
+
+```
+corepack enable
+yarn install --immutable
+yarn build
+```