Skip to content

Contributing

Read agent-guide.md before contributing code in this repository. It is the source of stable coding, testing, and documentation rules.

Set up a local editable install:

Terminal window
python3 -m venv .venv
.venv/bin/pip install -e ".[dev,duckdb,trino]"

Use repository entrypoints instead of bare Python tooling:

Terminal window
make format
make lint
make typecheck
make test
make examples-check

For Python-related commands in this repository, do not use bare python, pytest, mypy, or ruff. Use the make entrypoints or explicit .venv/bin/... paths.

Keep changes narrow, update affected user or API documentation with behavior changes, and avoid publishing internal planning material as user documentation.