Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

85 lines (56 loc) · 2.74 KB
Raw

Development

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

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

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

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

NOTE: You might run into issues where you have a local install and are trying to work with a plugin pinned to a specific version.

The easiest solution to this is to fetch the tags via git fetch upstream --tags and reinstall via pip install .. You will then have the correct version.

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.

GitHub Access Token

If you are a member of ApeWorX and would like to install private plugins, create a GitHub access token.

Once you have your token, export it to your terminal session:

export GITHUB_ACCESS_TOKEN=<your-token>

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:

python build_docs.py

For the best viewing experience, use a local server:

python -m http.server --directory "docs/_build/" --bind 127.0.0.1 1337

Then, open your browser to 127.0.0.1:1337 and click the ape directory link. NOTE: Serving from "docs/_build/" rather than "docs/_build/ape" is necessary to make routing work.

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.