-
Notifications
You must be signed in to change notification settings - Fork 331
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add a contributing.md with info on setting up the repo
- Loading branch information
steven
committed
Oct 27, 2023
1 parent
e5ae90d
commit 567c39f
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |