Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 1.33 KB
Raw

Development

To start development for Brownie you should begin by cloning the repo.

git clone https://github.com/iamdefinitelyahuman/brownie.git

Next, ensure all dev dependencies have been installed:

pip install -r requirements-dev.txt

Pre-Commit Hooks

We use pre-commit hooks to ensure consistent formatting among contributors.

Install pre-commit locally from the brownie root folder:

pre-commit install

Commiting will now automatically run the local pre-commit hooks, ensuring that your commit passes our lint checks.

Pull Requests

Pull requests are welcomed! Please adhere to the following:

  • Ensure your pull request passes our linting checks (tox -e lint)
  • 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 Brownie Gitter channel if you have any questions.