Skip to content

Commit 88681a8

Browse files
authored
Add installation instructions to CONTRIBUTING.md (#838)
1 parent 3a0cf08 commit 88681a8

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Contributing to convex-helpers
22

3+
## Installing dependencies for development
4+
5+
Run the following command in the _root_ of the repository (not `packages/convex-helpers`):
6+
7+
```sh
8+
npm install
9+
```
10+
11+
> [!NOTE]
12+
> There are two `package.json` files in the repository, one in the root and one in `packages/convex-helpers`. The dependencies in the root are a superset of all dependencies, including dependencies used during development only.
13+
14+
> [!IMPORTANT]
15+
> Do not run `npm install` in `packages/convex-helpers`: this might cause some dependencies to be installed twice, causing type errors.
16+
317
## Adding a helper
418

519
Adding helpers usually involves:

0 commit comments

Comments
 (0)