aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 46bb4e4..b6f678e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -13,7 +13,7 @@
13 - [How Can I Contribute?](#how-can-i-contribute) 13 - [How Can I Contribute?](#how-can-i-contribute)
14 - [Setting up your Development machine](#setting-up-your-development-machine) 14 - [Setting up your Development machine](#setting-up-your-development-machine)
15 - [Install System-level dependencies](#install-system-level-dependencies) 15 - [Install System-level dependencies](#install-system-level-dependencies)
16 - [Node.js, npm, node-gyp](#nodejs-npm-node-gyp) 16 - [Node.js, npm](#nodejs-npm)
17 - [Git](#git) 17 - [Git](#git)
18 - [Clone repository with submodule](#clone-repository-with-submodule) 18 - [Clone repository with submodule](#clone-repository-with-submodule)
19 - [Install dependencies](#install-dependencies) 19 - [Install dependencies](#install-dependencies)
@@ -40,19 +40,19 @@ As a basic rule, before filing issues, feature requests or anything else, please
40 40
41### Install System-level dependencies 41### Install System-level dependencies
42 42
43#### Node.js, npm, node-gyp 43#### Node.js, npm
44 44
45Please make sure you are running the exact node version used by the developers/contributors as specified in the [nvmrc file](./.nvmrc). 45Please make sure you are conforming to the `engines` requirements used by the developers/contributors as specified in the [`package.json`](./package.json#engines) and [`recipes/package.json`](./recipes/package.json#engine) files.
46 46
47Currently, these are the combinations of system dependencies that work on an intel-based machines for MacOS/Linux/Windows (building on an ARM-based machine is still a work-in-progress due to node-sass native dependencies) 47Currently, these are the combinations of system dependencies that work for MacOS/Linux/Windows:
48 48
49```bash 49```bash
50node -v 50$ jq --null-input '[inputs.engines] | add' < ./package.json < ./recipes/package.json
51v14.17.3 51{
52npm -v 52 "node": "16.14.2",
536.14.12 53 "npm": "8.7.0",
54node-gyp -v 54 "pnpm": "6.32.8"
55v8.0.0 55}
56``` 56```
57 57
58#### Git 58#### Git