diff options
author | Sadetdin EYILI <sad270@users.noreply.github.com> | 2021-09-05 01:16:14 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-09-05 04:46:14 +0530 |
commit | 574398aa3198c6ae63312a14fde5fd98df9f2f9b (patch) | |
tree | 8bf4cc74e29dc36a12c9dfc738692517d88d1409 /CONTRIBUTING.md | |
parent | New Crowdin updates (#1863) (diff) | |
download | ferdium-app-574398aa3198c6ae63312a14fde5fd98df9f2f9b.tar.gz ferdium-app-574398aa3198c6ae63312a14fde5fd98df9f2f9b.tar.zst ferdium-app-574398aa3198c6ae63312a14fde5fd98df9f2f9b.zip |
docs: improve contribution documentation (#1865) [skip ci]
Co-authored-by: Vijay Raghavan Aravamudhan <vraravam@users.noreply.github.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc3f9e73c..6a7091624 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
@@ -65,6 +65,8 @@ npm -v | |||
65 | 6.14.13 | 65 | 6.14.13 |
66 | ``` | 66 | ``` |
67 | 67 | ||
68 | _Note:_ You can choose any package manager to manage multiple versions of `node` and `npm`. For eg, [nvm](https://github.com/nvm-sh/nvm) or [asdf](https://github.com/asdf-vm/asdf). | ||
69 | |||
68 | #### Git | 70 | #### Git |
69 | 71 | ||
70 | The version [2.23.0](https://github.com/git-for-windows/git/releases/tag/v2.23.0.windows.1) for Git is working fine for development. You can then use the console from Git to do the development procedure. | 72 | The version [2.23.0](https://github.com/git-for-windows/git/releases/tag/v2.23.0.windows.1) for Git is working fine for development. You can then use the console from Git to do the development procedure. |
@@ -132,12 +134,12 @@ Run the following command to install all dependencies, and link sibling modules | |||
132 | npx lerna bootstrap | 134 | npx lerna bootstrap |
133 | ``` | 135 | ``` |
134 | 136 | ||
135 | If you previously ran `npm install`, it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. If you encounter the `gyp: No Xcode or CLT version` error on macOS at this step, please have a look [here](https://medium.com/flawless-app-stories/gyp-no-xcode-or-clt-version-detected-macos-catalina-anansewaa-38b536389e8d). | 137 | If you previously ran `npm install`, it is sometimes necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. If you encounter the `gyp: No Xcode or CLT version` error on macOS at this step, please have a look [here](https://medium.com/flawless-app-stories/gyp-no-xcode-or-clt-version-detected-macos-catalina-anansewaa-38b536389e8d). |
136 | 138 | ||
137 | ### Fix native modules to match current electron node version | 139 | ### Fix native modules to match current electron node version |
138 | 140 | ||
139 | ```bash | 141 | ```bash |
140 | npm run rebuild | 142 | npm run build |
141 | ``` | 143 | ``` |
142 | 144 | ||
143 | ### Package recipe repository | 145 | ### Package recipe repository |
@@ -235,3 +237,21 @@ git push | |||
235 | ``` | 237 | ``` |
236 | 238 | ||
237 | This will automatically trigger the build, as part of which, a new, draft release will be created [here](https://github.com/getferdi/ferdi/releases/). Once all the assets are uploaded (19 assets in total), publish the release (you will need elevated permissions in GitHub for doing this). The last commit of the `release` branch will be tagged. | 239 | This will automatically trigger the build, as part of which, a new, draft release will be created [here](https://github.com/getferdi/ferdi/releases/). Once all the assets are uploaded (19 assets in total), publish the release (you will need elevated permissions in GitHub for doing this). The last commit of the `release` branch will be tagged. |
240 | |||
241 | ## Update | ||
242 | |||
243 | ### Update the code | ||
244 | |||
245 | ```bash | ||
246 | git pull | ||
247 | ``` | ||
248 | |||
249 | ### Update Node.js and npm | ||
250 | |||
251 | If node.js and/or npm version have changed, don't forget to update them by running the appropriate command of your chosen package manager. | ||
252 | |||
253 | ### Update dependences | ||
254 | |||
255 | ```bash | ||
256 | npx lerna bootstrap | ||
257 | ``` | ||