1
0
mirror of https://github.com/elk-zone/elk synced 2024-11-27 06:18:07 +09:00

docs(contributing): update node and pnpm version (#2913)

This commit is contained in:
Chris​‌​‮ ‬Hayes‌​​​ 2024-08-09 01:57:18 -04:00 committed by GitHub
parent 4a3218dae3
commit fb7f2b5a8e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -18,10 +18,10 @@ To develop and test the Elk package:
1. Fork the Elk repository to your own GitHub account and then clone it to your local device. 1. Fork the Elk repository to your own GitHub account and then clone it to your local device.
2. Ensure using the latest Node.js (16.x). 2. Ensure using the latest Node.js (20.x).
If you have [nvm](https://github.com/nvm-sh/nvm), you can run `nvm i` to install the required version. If you have [nvm](https://github.com/nvm-sh/nvm), you can run `nvm i` to install the required version.
3. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/) v7. To use it you must first enable [Corepack](https://github.com/nodejs/corepack) by running `corepack enable`. (Note: on Linux in a standard Node 16+ environment, you should follow the instructions to install via Node's `corepack` rather than using the `curl` command) 3. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/) v9. To use it you must first enable [Corepack](https://github.com/nodejs/corepack) by running `corepack enable`. (Note: on Linux in a standard Node 20+ environment, you should follow the instructions to install via Node's `corepack` rather than using the `curl` command)
4. Check out a branch where you can work and commit your changes: 4. Check out a branch where you can work and commit your changes:
```shell ```shell