Skip to content

Commit 35fff8d

Browse files
authored
docs: add instructions to run locally (#1537)
1 parent 25782ca commit 35fff8d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ This repository houses the following tools:
1212

1313
<!-- prettier-ignore-end -->
1414

15+
## Contributing
16+
17+
We welcome contributions to this repository. Please see the
18+
[contribution guidelines](CONTRIBUTING.md). For running the project locally,
19+
20+
1. Clone the repository
21+
2. Make sure you have Node.js `>=20.x` installed
22+
3. Make sure you have [`pnpm`] installed:
23+
[https://pnpm.io/installation](https://pnpm.io/installation)
24+
4. Run `pnpm install` to install dependencies
25+
5. Run `pnpm build` to build the packages
26+
1527
## Release process
1628

1729
We use `changeset` to manage releases. Every PR should include a changeset file. The release process

0 commit comments

Comments
 (0)