Contributing Guidelines

Coding Style Guide

This project uses black (line length 120) and flake8 for code style. Both are run automatically via pre-commit (see .pre-commit-config.yaml for the exact configuration).

To begin with, you should follow the step below to install pre-commit.

pip install pre-commit

Then, you should config the pre-commit hook as below.

pre-commit install

Then when you commit your change, your code will be automatically checked.