Contributing
How to contribute to the Beep.AI platform
Getting Started
- Read AGENTS.md for coding rules and service design patterns
- Read docs/ENGINEERING_IMPLEMENTATION_GUIDELINES.md
- Start with docs/INDEX.md for documentation structure
Code Standards
- PEP 8 with type hints
- Files under 300-500 lines — split when necessary
- One responsibility per file
- Thin routes — parse input, delegate to services, shape response
- Strongly-typed contracts — @dataclass or TypedDict, never raw dict
- Production-ready only — no stubs, placeholders, or # TODO
- No backward-compatible shims — delete old paths, update all callers
Testing
pytest # All tests
pytest tests/test_agents_routes.py -v # Specific file
pytest --cov=app # With coveragePull Request Process
- Fork the repository
- Create a feature branch
- Add focused tests for changed responsibilities
- Commit with clear messages
- Push and open a Pull Request