We welcome contributions to this project. For non-trivial improvements, we would encourage discussion in a GitHub issue before opening a pull request. This is also a great contribution in and of itself as it lets us know where to focus development efforts.
The first step is to fork the repository and clone it to your computer. Once you have done that, we recommend setting up a virtual environment to encapsulate the project’s dependencies. To install the third-party packages required by the project, run:
pip install -e .
Based on the contribution you are making, you may have to install additional dependencies.
# To run tests pip install -r requirements/test.txt # To build documentation locally pip install -r requirements/docs.txt
This project contains a comprehensive test suite. To run the tests locally, make sure the test requirements are installed and then execute: