Contributing¶

Follow these guidelines when contributing to FermiLink.

Development setup¶

Start by setting up the development environment:

git clone https://github.com/TaoELi/FermiLink.git
cd FermiLink/
pip install -e ".[dev,docs]"

After making code changes, update the documentation in docs/source/ and the table of contents in docs/source/index.rst if necessary.

Build the documentation website locally with (from the repo root):

make doc html

Before opening a pull request, run the quality checks and unit tests:

# code quality and style checks
make lint
make pretty
# unit tests need to be passed
pytest -q