diff options
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 22 |
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 | |||
60 | node -v | 62 | node -v |
61 | v14.17.3 | 63 | v14.17.3 |
62 | npm -v | 64 | npm -v |
63 | 6.14.12 | 65 | 6.14.13 |
64 | node-gyp -v | ||
65 | v8.0.0 | ||
66 | ``` | 66 | ``` |
67 | 67 | ||
68 | #### Git | 68 | #### Git |
@@ -91,6 +91,20 @@ Please make sure you run this command as an administrator: | |||
91 | npm i -g windows-build-tools --vs2015 | 91 | npm i -g windows-build-tools --vs2015 |
92 | ``` | 92 | ``` |
93 | 93 | ||
94 | #### node-gyp | ||
95 | |||
96 | We need `node-gyp` to be able to compile any native dependencies | ||
97 | |||
98 | ```bash | ||
99 | npm ls -g node-gyp@8.1.0 || npm i -g node-gyp@8.1.0 | ||
100 | ``` | ||
101 | |||
102 | #### Lerna | ||
103 | |||
104 | ```bash | ||
105 | npm 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 | |||
99 | git submodule update --init --recursive | 113 | git submodule update --init --recursive |
100 | ``` | 114 | ``` |
101 | 115 | ||
102 | It is important you execute the last command to get the required submodules (recipes, server). | 116 | It 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 | ||