Contributing¶

The most welcome areas of contribution are:

• security improvements
• tests
• documentation
• UserStore implementations
• EmailSender implementations
• framework integrations as separate packages

Before starting work on a storage, email, or framework integration, read the integrations documentation and review the official adapters:

• userharbor-sqlalchemy
• userharbor-smtp
• userharbor-fastapi

Local development¶

We use uv to manage the development environment. After installing uv, run these commands from the repository root:

uv sync                       # Create .venv and install development dependencies
uv run pytest                 # Run tests
uv run zensical build --clean # Build documentation in site/
uv run zensical serve         # Preview documentation locally