Skip to content

Contributing

We welcome contributions! Whether you're reporting a bug, suggesting a feature, or writing code, here's how to get involved.

Ways to Contribute

  • Report bugs: Check GitHub Issues, open a new one if it doesn't exist
  • Suggest features: Open an issue to start a discussion
  • Write code: Pick an existing issue or propose a new one

Quick Reference

Topic What's Covered
Code Style Typing conventions, schema patterns, controller patterns, query optimization
Testing pytest setup, factories, coverage, what to test
Dependency Management UV workflow, adding/removing packages
CI Pipeline GitHub Actions, make check, make test, what CI enforces

Development Workflow

  1. Fork the repository on GitHub
  2. Clone your fork and run make setup
  3. Branch from main: git checkout -b feature/my-feature
  4. Write code following the code style guide
  5. Write tests for your changes
  6. Run checks: make check && make test
  7. Push and open a Pull Request

Commit Messages

We use Conventional Commits: feat:, fix:, chore:, docs:, refactor:, test:.

Community