Skip to content

how to contribute tooling

Bryan edited this page Jun 13, 2026 · 1 revision

Tooling

The tooling stack is intentionally local and command-line friendly. pyproject.toml configures formatting, linting, typing, coverage, complexity, dead-code, dependency, and security checks.

Validation tools

Tool Config Purpose
Ruff pyproject.toml Format and lint Python.
mypy pyproject.toml Type-check src, tests, scripts, and benchmarks.
coverage pyproject.toml Enforce the coverage gate.
Radon CI command in .github/workflows/ci.yml Complexity gate.
Vulture CI command in .github/workflows/ci.yml Dead-code scan.
Deptry pyproject.toml Dependency hygiene.
Bandit pyproject.toml Static security checks.
pip-audit CI command in .github/workflows/ci.yml Dependency vulnerability scan.

Repository policy scripts

Script Purpose
scripts/check_large_files.py Blocks unexpectedly large tracked files.
scripts/check_todos.py Enforces linked maintenance markers.
scripts/check_agents_md.py Checks agent instructions.
scripts/check_feature_flags.py Checks feature flag conventions.
scripts/check_duplicate_code.py Flags repeated code blocks.
scripts/generate_openapi_docs.py Keeps docs/api/loded.md in sync with openapi/loded.openapi.yml.

Automation

CI runs in .github/workflows/ci.yml, CodeQL in .github/workflows/codeql.yml, PR readiness comments in .github/workflows/pr-review.yml, and release publishing in .github/workflows/publish.yml.

Related pages

Clone this wiki locally