22 / project

Contributing

A small contribution path for a personal, pre-1.0 open-source project.

Edit this pageUpdated with the source

Local setup

python -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
pytest
ruff check reachq tests scripts
mypy reachq

Before opening a pull request

Add tests for behavior changes, update the relevant user or research documentation, and add a changelog entry for public behavior changes. Keep the public top-level API deliberate; experimental work belongs under reachq.research or an explicitly marked optional backend.

Read the repository contribution guide ↗ for the full workflow.