From ff5bfbf4d8e2a06a14eb9a2a5b28c2a2a6b9907d Mon Sep 17 00:00:00 2001 From: smol-ninja Date: Sat, 9 Dec 2023 02:16:16 +0000 Subject: [PATCH] docs: guideline for fork testing --- CONTRIBUTING.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 59bf4ba9e..28542e4b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -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: