Skip to content

Commit

Permalink
docs: add a contributing.md with info on setting up the repo
Browse files Browse the repository at this point in the history
  • Loading branch information
steven committed Oct 27, 2023
1 parent e5ae90d commit 567c39f
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@


## Setup Repo

git clone --recurse-submodules -j8 [email protected]:sablier-labs/v2-core.git

### Install Dependencies

npm install

npx husky install

npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}'

forge install

### Pull Requests

All tests must pass

Commits must be linted

A descriptive summary of the PR has been provided.

### Environment Variables

Some of the tests and features of this repository require environment variables to be set up.

Copy the .env.example file to create a .env and populate it with the appropriate environment values that you have control control

0 comments on commit 567c39f

Please sign in to comment.