Contributing

Thank you for your interest in improving the celo-ethers-wrapper.

This guide is intended to help you get started with contributing. By following these steps, you will understand the development process and workflow.

To start contributing to the project, fork it and clone it to your local machine using git:

$ git clone https://github.com/jmrossy/celo-ethers-wrapper.git

Navigate to the project's root directory:

$ cd celo-ethers-wrapper

We use Node.js to run the project locally. You need to install the Node.js version specified in package.json > engines > node. To do so, run:

$ nvm install <specified-version>
$ nvm use <specified-version>

Once in the project's root directory, run the following command to install the project's dependencies:

$ yarn install

After installing the dependencies, the project is ready to be run.

Create an .env.test.local file:

$ cp tests/.env.test.example tests/.env.test.local

Generate a brand new wallet (or use an existing development wallet of yours) and paste its mnemonic phrase into .env.test.local:
```
MNEMONIC='<PASTE YOUR MNEMONIC PHRASE HERE>'
```
Ensure the wallet address has at least 1 CELO and 1 USDC on the Celo Alfajores testnet.

If you need more, you can request:
1. testnet CELO at faucet.celo.org, and
2. testnet USDC from faucet.circle.com.
Now you're ready to run tests with:
```
$ yarn test
```

INFO Some tests are run automatically when you open a Pull Request on GitHub.

✅ Now you're ready to contribute to celo-ethers-wrapper!

Provide feedback