aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLibravatar Vijay Aravamudhan <vraravam@users.noreply.github.com>2024-03-28 10:12:05 +0000
committerLibravatar GitHub <noreply@github.com>2024-03-28 15:42:05 +0530
commit53c72ea5ac4f103291fdd347b7cd9cc0dbafa4b5 (patch)
treeb5317730f7e7ac879732c1557a53ef4515a654e4 /CONTRIBUTING.md
parentUpgrade electron to '29.1.6' (diff)
downloadferdium-app-53c72ea5ac4f103291fdd347b7cd9cc0dbafa4b5.tar.gz
ferdium-app-53c72ea5ac4f103291fdd347b7cd9cc0dbafa4b5.tar.zst
ferdium-app-53c72ea5ac4f103291fdd347b7cd9cc0dbafa4b5.zip
Bring in missing python (system dependency) (#1639)
* Introduce python as a system dependency (needed by node-gyp to compile native modules) * Introduce node-pre-gyp as a dependency * Upgrade sqlite3 to 5.1.7 to test the above Note: Currently this still depends on the availability of prebuilt binaries from the prebuild library. Which means that once a new version is available, only then will we know if this python/node-gyp integration works or whether it will still fallback to the availability of the prebuilt binaries from external sources. Only time will tell if we have solved the issue or not.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 887a72a5a..753068434 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, pnpm](#nodejs-pnpm) 16 - [Node.js, pnpm, python](#nodejs-pnpm-python)
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, pnpm 55#### Node.js, pnpm, python
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,11 +63,14 @@ 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": "20.11.1", 65 "node": "20.11.1",
66 "pnpm": "8.15.5" 66 "pnpm": "8.15.5",
67 "python": "3.11.8"
67} 68}
68``` 69```
69 70
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). 71Python is only/mainly required to compile any dependencies for which the binary is not found, and we have to resort to compiling from source (for eg sqlite3)
72
73_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 [mise](https://github.com/jdx/mise).
71 74
72#### Git 75#### Git
73 76