Contributing

The gate is strict — and that’s a selling point. Here’s exactly what CI expects.

The gate — all three must pass

mypy src tests
ruff format --check .
pytest            # full suite

The classic trap

mypy src alone passes locally and fails CI. You must include tests: mypy src tests.

Where to start

• Grab a good first issue — pulled live from the GitHub API.
• Branch off develop, never main.
• Design records live in docs/specs/ — read the spec before changing a subsystem.

Links

• CONTRIBUTING.md
• Code of Conduct
• Security policy — coordinated disclosure; do not open a public issue for vulnerabilities.