Contributing¶
This page describes the local development workflow for beadsflow (using uv + just), the Definition of Done (DoD), and how to build the docs.
Prerequisites¶
uvinstalledjustinstalled
Local dev workflow (uv + just)¶
Create/refresh the virtualenv and sync dependencies:
uv sync
Run a command inside the environment:
uv run beadsflow --help
Most common tasks are wrapped in the Justfile:
just test
just typecheck
just lint
Definition of Done¶
Before requesting review, run:
just test
just typecheck
just lint
Docs¶
Build the HTML docs locally:
just docs
Equivalent manual command:
uv sync --group docs
uv run sphinx-build -b html docs docs/_build/html