Getting Started

  1. Read AGENTS.md for coding rules and service design patterns
  2. Read docs/ENGINEERING_IMPLEMENTATION_GUIDELINES.md
  3. 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 coverage

Pull Request Process

  1. Fork the repository
  2. Create a feature branch
  3. Add focused tests for changed responsibilities
  4. Commit with clear messages
  5. Push and open a Pull Request