Skip to content

Commit

Permalink
Merge pull request #235 from sablier-labs/docs/contributing
Browse files Browse the repository at this point in the history
docs: add guidelines for fork testing
  • Loading branch information
PaulRBerg authored Dec 15, 2023
2 parents 1123aee + d666f25 commit 83197d2
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Now you can start making changes.
When making a pull request, ensure that:

- All tests pass.
- Fork testing requires environment variables to be set up in the forked repo.
- Code coverage remains the same or greater.
- All new code adheres to the style guide:
- All lint checks pass.
Expand All @@ -52,10 +53,19 @@ When making a pull request, ensure that:

## Environment Variables

Some of the features of this repository, such as deployments, require environment variables to be set up.
### Local setup

Follow the [`.env.example`](./.env.example) file to create a `.env` file at the root of the repo and populate it with
the appropriate environment values. You need to provide your mnemonic phrase and a few API keys.
To build locally, follow the [`.env.example`](./.env.example) file to create a `.env` file at the root of the repo and
populate it with the appropriate environment values. You need to provide your mnemonic phrase and a few API keys.

### Deployment

To make CI work in your pull request, ensure that the necessary environment variables are configured in your forked
repository's secrets. Please add the following variables in your GitHub Secrets:

- API_KEY_ETHERSCAN
- API_KEY_INFURA
- RPC_URL_MAINNET

## Integration with VSCode:

Expand Down

0 comments on commit 83197d2

Please sign in to comment.