Skip to content

Commit

Permalink
docs: up contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
tmm committed Jun 24, 2024
1 parent 4f0a750 commit 189684b
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions site/dev/contributing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<script setup>
import packageJson from '../../package.json'

const nodeVersion = packageJson.engines.node
const packageManager = packageJson.packageManager
</script>

Expand Down Expand Up @@ -34,23 +35,23 @@ gh repo clone wevm/wagmi

## 2. Installing Node.js and pnpm

Wagmi uses [pnpm workspaces](https://pnpm.io/workspaces) to manage multiple projects. You need to install **Node.js v18 or higher** and **{{packageManager}}**.

You can run the following commands in your terminal to check your local Node.js and pnpm versions:
Wagmi uses Node.js with [pnpm workspaces](https://pnpm.io/workspaces) to manage multiple projects. You can run the following command in your terminal to check your local Node.js version.

```bash
node -v
pnpm -v
```

If the versions are not correct or you don't have Node.js or pnpm installed, download and follow their setup instructions:
If **`node@{{nodeVersion}}`** is not installed, you can install via [fnm](https://github.com/Schniz/fnm) or from the [official website](https://nodejs.org).

Once Node.js is installed, run the following to install [Corepack](https://nodejs.org/api/corepack.html). Corepack automatically installs and manages **`{{packageManager}}`**.

- Install Node.js using [fnm](https://github.com/Schniz/fnm) or from the [official website](https://nodejs.org)
- Install [pnpm](https://pnpm.io/installation) using [Corepack](https://nodejs.org/api/corepack.html)
```bash
corepack enable
```

## 3. Installing dependencies

Once in the project's root directory, run the following command to install the project's dependencies:
Once in the project's root directory, run the following command to install pnpm (via Corepack) and the project's dependencies:

```bash
pnpm install
Expand Down Expand Up @@ -163,8 +164,9 @@ If a PR has changesets, you can create a [snapshot release](https://github.com/c
Use [Taze](https://github.com/antfu/taze) by running:

```bash
pnpm deps # prints outdated deps
pnpm deps -w # updates deps (best done with clean working tree)
pnpm deps # prints outdated deps
pnpm deps patch # print outdated deps with new patch versions
pnpm deps -w # updates deps (best done with clean working tree)
```

[Socket](https://socket.dev) checks pull requests for vulnerabilities when new dependencies and versions are added, but you should also be vigilant! When updating dependencies, you should check release notes and source code as well as lock versions when possible.

0 comments on commit 189684b

Please sign in to comment.