summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLibravatar Balaji Vijayakumar <kuttibalaji.v6@gmail.com>2022-11-25 05:31:46 +0530
committerLibravatar GitHub <noreply@github.com>2022-11-25 00:01:46 +0000
commitc04b71b2c79bdc5b1612ef0e98f351d1193bdec9 (patch)
treeb46106d37f6d4ecc2bb366fcf5418ac3f478fe42 /CONTRIBUTING.md
parentPull in new version of 'recipes' submodule (diff)
downloadferdium-app-c04b71b2c79bdc5b1612ef0e98f351d1193bdec9.tar.gz
ferdium-app-c04b71b2c79bdc5b1612ef0e98f351d1193bdec9.tar.zst
ferdium-app-c04b71b2c79bdc5b1612ef0e98f351d1193bdec9.zip
Switch npm to pnpm (#714)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md11
1 files changed, 5 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ee24d8ffa..5b712c1ec 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, pnpm](#nodejs-npm-pnpm) 16 - [Node.js, pnpm](#nodejs-pnpm)
17 - [Git](#git) 17 - [Git](#git)
18 - [On Debian/Ubuntu](#on-debianubuntu) 18 - [On Debian/Ubuntu](#on-debianubuntu)
19 - [On Fedora](#on-fedora) 19 - [On Fedora](#on-fedora)
@@ -52,7 +52,7 @@ If so, engage in the already existing discussion.
52 52
53_Note:_ This list can likely get outdated. If so, please refer to the specific version of the [electronuserland builder](https://hub.docker.com/r/electronuserland/builder) that we use in our [Dockerfile](./Dockerfile). 53_Note:_ This list can likely get outdated. If so, please refer to the specific version of the [electronuserland builder](https://hub.docker.com/r/electronuserland/builder) that we use in our [Dockerfile](./Dockerfile).
54 54
55#### Node.js, npm, pnpm 55#### Node.js, pnpm
56 56
57Please 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. 57Please 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.
58 58
@@ -63,12 +63,11 @@ Currently, these are the combinations of system dependencies that work for MacOS
63$ jq --null-input '[inputs.engines] | add' < ./package.json < ./recipes/package.json 63$ jq --null-input '[inputs.engines] | add' < ./package.json < ./recipes/package.json
64{ 64{
65 "node": "16.18.0", 65 "node": "16.18.0",
66 "npm": "8.19.2",
67 "pnpm": "7.17.0" 66 "pnpm": "7.17.0"
68} 67}
69``` 68```
70 69
71_Note:_ You can choose any version 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). 70_Note:_ You can choose any version manager to manage multiple versions of `node` and `pnpm`. For eg, [nvm](https://github.com/nvm-sh/nvm) or [asdf](https://github.com/asdf-vm/asdf).
72 71
73#### Git 72#### Git
74 73
@@ -90,7 +89,7 @@ dnf install libX11-devel libXext-devel libXScrnSaver-devel libxkbfile-devel rpm
90 89
91Please make sure you have the following installed: 90Please make sure you have the following installed:
92 91
93- Microsoft Visual Studio Build Tools (2019 or higher - with Windows 10 SDK selected). 92- Microsoft Visual Studio Build Tools (2017, 2019 or 2022 - with Windows 10 SDK selected).
94 93
95### Clone repository with submodule 94### Clone repository with submodule
96 95
@@ -147,7 +146,7 @@ mv /ferdium/latest-linux.yml /ferdium-out/latest-linux-$GIT_SHA.yml
147Run this command on the terminal: 146Run this command on the terminal:
148 147
149```bash 148```bash
150npm run debug 149pnpm debug
151``` 150```
152 151
153Note: please prefer [`debug()`](https://github.com/visionmedia/debug) over `console.log()`. 152Note: please prefer [`debug()`](https://github.com/visionmedia/debug) over `console.log()`.