Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

77 lines (51 loc) · 2.1 KB
Raw

Development

To get started with working on the codebase, use the following steps prepare your local environment:

# clone the github repo and navigate into the folder
git clone https://github.com/ApeWorX/ape-hardhat.git
cd ape-hardhat

# create and load a virtual environment
python3 -m venv venv
source venv/bin/activate

# install ape-hardhat into the virtual environment
python setup.py install

# install the developer dependencies (-e is interactive mode)
pip install -e .'[dev]'

Pre-Commit Hooks

We use pre-commit hooks to simplify linting and ensure consistent formatting among contributors. Use of pre-commit is not a requirement, but is highly recommended.

Install pre-commit locally from the root folder:

pip install pre-commit
pre-commit install

Committing will now automatically run the local hooks and ensure that your commit passes all lint checks.

Running the docs locally

First, make sure you have the docs-related tooling installed:

pip install -e .'[doc]'

Then, run the following from the root project directory:

sphinx-ape build .

For the best viewing experience, use a local server:

sphinx-ape serve .

Then, open your browser to 127.0.0.1:1337 and click the ape directory link.

You can also use the --open flag to automatically open the docs:

sphinx-ape serve . --open

Pull Requests

Pull requests are welcomed! Please adhere to the following:

  • Ensure your pull request passes our linting checks
  • Include test cases for any new functionality
  • Include any relevant documentation updates

It's a good idea to make pull requests early on. A pull request represents the start of a discussion, and doesn't necessarily need to be the final, finished submission.

If you are opening a work-in-progress pull request to verify that it passes CI tests, please consider marking it as a draft.

Join the ApeWorX Discord if you have any questions.