Skip to content

Commit

Permalink
docs: add more context in contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulRBerg committed Jan 1, 2024
1 parent 5600ad1 commit 44c82ee
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,21 @@ Clone this repository including submodules:
$ git clone --recurse-submodules -j8 [email protected]:sablier-labs/v2-periphery.git
```

Then, inside the project's directory, run this to install the Node.js dependencies:
Then, inside the project's directory, run this to install the Node.js dependencies and build the contracts:

```shell
$ bun install
$ bun run build
```

Now you can start making changes.

To see a list of all available scripts:

```shell
$ bun run
```

## Pull Requests

When making a pull request, ensure that:
Expand Down

0 comments on commit 44c82ee

Please sign in to comment.