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-aws-kms.git
cd ape-aws-kms
# create and load a virtual environment
python3 -m venv venv
source venv/bin/activate
# install brownie into the virtual environment
python setup.py install
# install the developer dependencies (-e is interactive mode)
pip install -e .[dev]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 installCommitting will now automatically run the local hooks and ensure that your commit passes all lint checks.
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 Ethereum Python Discord if you have any questions.