Skip to content

Commit

Permalink
docs: guideline for fork testing
Browse files Browse the repository at this point in the history
  • Loading branch information
smol-ninja committed Dec 9, 2023
1 parent 4cb7860 commit ff5bfbf
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 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,18 @@ 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.
### Deployment

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 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 variable to your
[github secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions):

- RPC_URL_MAINNET

### Local setup

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.

## Integration with VSCode:

Expand Down

0 comments on commit ff5bfbf

Please sign in to comment.