Skip to content

Commit

Permalink
chore: update Node.js install in CONTRIBUTING.md (#1821)
Browse files Browse the repository at this point in the history
  • Loading branch information
Timeless0911 authored Feb 7, 2025
1 parent ea3b304 commit dd84260
Showing 1 changed file with 8 additions and 18 deletions.
26 changes: 8 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,21 @@ own GitHub account and then [clone](https://help.github.com/articles/cloning-a-r

### Install Node.js

We recommend using Node.js 18. You can check your currently used Node.js version with the following command:
Use [fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm) to run the command below. This will switch to the Node.js version specified in the project's `.nvmrc` file.

```bash
node -v
```

If you do not have Node.js installed in your current environment, you can use [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm) to install it.

Here is an example of how to install the Node.js 18 LTS version via nvm:

```bash
# Install the LTS version of Node.js 18
nvm install 18 --lts
# with fnm
fnm use

# Make the newly installed Node.js 18 as the default version
nvm alias default 18

# Switch to the newly installed Node.js 18
nvm use 18
# with nvm
nvm use
```

### Install pnpm

```sh
# Enable pnpm with corepack, only available on Node.js >= `v14.19.0`
Enable [pnpm](https://pnpm.io/) with corepack:

```bash
corepack enable
```

Expand Down

0 comments on commit dd84260

Please sign in to comment.