Skip to content

Maintainability checks

The repository uses automated checks to keep package boundaries, names, technical-debt markers, and dependencies clear.

Run the checks locally

uv run ruff check . --select N,TD
uv run deptry .
uv run lint-imports

ruff checks naming consistency and technical-debt comments. deptry finds unused, missing, and transitive-only dependencies. lint-imports checks that package layers depend only on lower layers:

orchestration → enrichment / ingesters → adapters → core

The arrows show the allowed direction. A lower layer must not import a higher layer.

Track technical debt

Use GitHub Issues as the technical-debt register. Do not add a markdown TODO list. Create an issue with gh issue create, then reference it in the code:

# TODO(owner): simplify this boundary after the adapter split (#123)

Ruff rejects TODO comments without an owner or an issue reference. Use a specific comment that states the required change and the reason it matters.