Contributing¶

Local checks¶

From the repository root (see justfile):

Command	Purpose
`just test`	Full pytest suite
`just lint`	Ruff check with safe fixes
`just format`	Ruff format
`just typecheck`	Static types (`ty`)
`just audit`	Dependency audit (`pip-audit`, `deptry`)
`just docs-serve`	Live Zensical preview
`just docs-build`	Static site to `site/`

For release-quality verification from the repo root (with uv):

uv run ruff check --fix .
uv run ruff format .
uv run ty check
uv run deptry .
uv run pytest

Tests¶

Keep the testing docs aligned by audience:

Testing plugin-backed apps is the canonical app-level guide for pytest-only testing mode, AsyncTestClient, request-scoped session sharing, and auth-state isolation boundaries.
tests/README.md is the repo-internal guide for the test pyramid, pytest markers (unit, integration, e2e, imports), and targeted local runs.

Before claiming completion or opening a PR, run the full verification block above from the repo root. CI enforces high coverage on litestar_auth/.

Documentation maintenance¶

When you change HTTP routes, ErrorCode values, or security-sensitive configuration, update the docs in the same change as the code. Use this map to find the right page:

Topic	Primary docs
Scope / boundaries	Roadmap
Architecture	Architecture, Backends, Request lifecycle
HTTP routes	HTTP API
Flows, errors, operational security	Security, Registration, OAuth, TOTP, Rate limiting, Errors, Security overview
Configuration	Configuration, Plugin API
Hooks / extension	Hooks, Extending
Production	Security, Deployment

Style¶

Python 3.12+, no Pydantic inside the library’s public contracts where msgspec is used.
Follow existing patterns; run just lint and just format before pushing.