aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md22
1 files changed, 18 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0b643ea10..1c3fb977f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -18,6 +18,8 @@
18 - [Debian/Ubuntu](#debianubuntu) 18 - [Debian/Ubuntu](#debianubuntu)
19 - [Fedora](#fedora) 19 - [Fedora](#fedora)
20 - [Windows](#windows) 20 - [Windows](#windows)
21 - [node-gyp](#node-gyp)
22 - [Lerna](#lerna)
21 - [Clone repository with submodule](#clone-repository-with-submodule) 23 - [Clone repository with submodule](#clone-repository-with-submodule)
22 - [Local caching of dependencies](#local-caching-of-dependencies) 24 - [Local caching of dependencies](#local-caching-of-dependencies)
23 - [Install dependencies](#install-dependencies) 25 - [Install dependencies](#install-dependencies)
@@ -60,9 +62,7 @@ Currently, these are the combinations of system dependencies that work for MacOS
60node -v 62node -v
61v14.17.3 63v14.17.3
62npm -v 64npm -v
636.14.12 656.14.13
64node-gyp -v
65v8.0.0
66``` 66```
67 67
68#### Git 68#### Git
@@ -91,6 +91,20 @@ Please make sure you run this command as an administrator:
91npm i -g windows-build-tools --vs2015 91npm i -g windows-build-tools --vs2015
92``` 92```
93 93
94#### node-gyp
95
96We need `node-gyp` to be able to compile any native dependencies
97
98```bash
99npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0
100```
101
102#### Lerna
103
104```bash
105npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0
106```
107
94### Clone repository with submodule 108### Clone repository with submodule
95 109
96```bash 110```bash
@@ -99,7 +113,7 @@ cd ferdi
99git submodule update --init --recursive 113git submodule update --init --recursive
100``` 114```
101 115
102It is important you execute the last command to get the required submodules (recipes, server). 116It is important you execute the last command to get the required submodules (recipes).
103 117
104### Local caching of dependencies 118### Local caching of dependencies
105 119