Format
Format the codebase using ruff:Validate
Lint and type-check using ruff and mypy:Configuration is in
pyproject.toml. Run both scripts before every commit.Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Format and validate your code before committing
./scripts/format.sh
ruff format .
./scripts/validate.sh
ruff check .
mypy .
pyproject.toml. Run both scripts before every commit.# 1. Format
./scripts/format.sh
# 2. Validate
./scripts/validate.sh
# 3. If both pass, commit
git add .
git commit -m "your message"
| Issue | Solution |
|---|---|
ruff not found | Run uv pip install ruff |
mypy not found | Run uv pip install mypy |
| Type errors | Fix the types or add # type: ignore comment |
| Import sorting | Run ruff check --fix . to auto-fix |
Was this page helpful?