Contributing to ChiRho

Development

Please follow our established coding style including variable names, module imports, and function definitions. The ChiRho codebase follows the PEP8 style guide (which you can check with make lint) and follows isort import order (which you can enforce with make format).

Dev Setup

To install dev dependencies for ChiRho, run the following command.

pip install -e .[test]

Testing

Before submitting a pull request, please autoformat code and ensure that unit tests pass locally

make lint              # linting
make format            # runs black and isort
make tests             # linting and unit tests

Submitting

For relevant design questions to consider, see Pyro’s past design documents.

For larger changes, please open an issue for discussion before submitting a pull request.

In your PR, please include:

• Changes made

• Links to related issues/PRs

• Tests

• Dependencies

For speculative changes meant for early-stage review, include [WIP] in the PR’s title. (One of the maintainers will add the WIP tag.)

Code of conduct

This project follows GitHub community guidelines and Pyro code of conduct.