Skip to content

Development

Resources for setting up, testing, and contributing to the BigBrotr project.

  • Setup

    Prerequisites, installation, IDE configuration, project structure, and Makefile targets.

  • Testing

    Test configuration, running tests, shared fixtures, mock patterns, async patterns, and coverage requirements.

  • Coding Standards

    Ruff linting, mypy strict mode, pre-commit hooks, import conventions, and documentation standards.

  • SQL Templates

    Jinja2 template system for generating deployment-specific database initialization files.

  • Contributing

    Code of conduct, branch and commit conventions, and pull request process.

Quick verification

After completing the setup, verify everything works:

make ci