aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLibravatar Vijay Aravamudhan <vraravam@users.noreply.github.com>2021-10-15 19:09:43 +0530
committerLibravatar GitHub <noreply@github.com>2021-10-15 19:09:43 +0530
commitf453ec83142be417b79ad0ac8c794a44f2e3b4da (patch)
treee44d20bb85711c8f5d3f962eb04d459e7dfdb3ff /CONTRIBUTING.md
parentchore: move 'packages/themes' into 'src' (no longer an injected package) (#2080) (diff)
downloadferdium-app-f453ec83142be417b79ad0ac8c794a44f2e3b4da.tar.gz
ferdium-app-f453ec83142be417b79ad0ac8c794a44f2e3b4da.tar.zst
ferdium-app-f453ec83142be417b79ad0ac8c794a44f2e3b4da.zip
chore: remove 'lerna' since we don't use monorepo-style packages any more (#2081)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md36
1 files changed, 6 insertions, 30 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 49ec44b3f..a8b580df0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,7 +19,6 @@
19 - [Fedora](#fedora) 19 - [Fedora](#fedora)
20 - [Windows](#windows) 20 - [Windows](#windows)
21 - [node-gyp](#node-gyp) 21 - [node-gyp](#node-gyp)
22 - [Lerna](#lerna)
23 - [Clone repository with submodule](#clone-repository-with-submodule) 22 - [Clone repository with submodule](#clone-repository-with-submodule)
24 - [Local caching of dependencies](#local-caching-of-dependencies) 23 - [Local caching of dependencies](#local-caching-of-dependencies)
25 - [Install dependencies](#install-dependencies) 24 - [Install dependencies](#install-dependencies)
@@ -33,10 +32,7 @@
33 - [Javascript Coding style-checker](#javascript-coding-style-checker) 32 - [Javascript Coding style-checker](#javascript-coding-style-checker)
34 - [Packaging](#packaging) 33 - [Packaging](#packaging)
35 - [Release](#release) 34 - [Release](#release)
36 - [Update](#update) 35 - [Updating the code after a hiatus](#updating-the-code-after-a-hiatus)
37 - [Update the code](#update-the-code)
38 - [Update Node.js and npm](#update-nodejs-and-npm)
39 - [Update dependences](#update-dependences)
40 36
41<!-- /TOC --> 37<!-- /TOC -->
42 38
@@ -107,12 +103,6 @@ We need `node-gyp` to be able to compile any native dependencies
107npm ls -g node-gyp@8.2.0 || npm i -g node-gyp@8.2.0 103npm ls -g node-gyp@8.2.0 || npm i -g node-gyp@8.2.0
108``` 104```
109 105
110#### Lerna
111
112```bash
113npm ls -g lerna@4.0.0 || npm i -g lerna@4.0.0
114```
115
116### Clone repository with submodule 106### Clone repository with submodule
117 107
118```bash 108```bash
@@ -137,10 +127,10 @@ export ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
137Run the following command to install all dependencies, and link sibling modules with Ferdi. 127Run the following command to install all dependencies, and link sibling modules with Ferdi.
138 128
139```bash 129```bash
140npx lerna bootstrap 130npm i
141``` 131```
142 132
143If 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). 133If 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).
144 134
145### Fix native modules to match current electron node version 135### Fix native modules to match current electron node version
146 136
@@ -223,7 +213,7 @@ Note: please prefer [`debug()`](https://github.com/visionmedia/debug) over `cons
223 213
224#### Javascript Coding style-checker 214#### Javascript Coding style-checker
225 215
226- Please use `es-lint` and the defined rules to maintain a consistent style 216- Please use `prettier` and the defined rules to maintain a consistent style
227 217
228## Packaging 218## Packaging
229 219
@@ -248,20 +238,6 @@ git push
248 238
249This 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. 239This 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.
250 240
251## Update 241### Updating the code after a hiatus
252 242
253### Update the code 243Since we are making a lot of changes that involve restructuring the code as well as taking a hard look at the dependencies (including node versions), please remember to update them by running the appropriate command of your chosen package manager.
254
255```bash
256git pull
257```
258
259### Update Node.js and npm
260
261If node.js and/or npm version have changed, don't forget to update them by running the appropriate command of your chosen package manager.
262
263### Update dependences
264
265```bash
266npx lerna bootstrap
267```