Skip to content

Task Templates

🎯 Objective

📋 Requirements

🛑 Constraints & Rules

  • Follow project coding standards defined in pyproject.toml
  • Use Test-Driven Development (TDD) approach
  • All code must pass linting (ruff check .) and type checking (mypy)

✅ Acceptance Criteria (Definition of Done)

  • Test file created and all tests pass: pytest tests/test_<FEATURE>.py -v
  • Code coverage >= 80%: pytest --cov=<MODULE> --cov-report=term
  • No linting errors: ruff check <MODULE>/
  • Type checking passes: mypy <MODULE>/
  • Documentation updated: ls -la docs/<FEATURE>.md

📚 Context & Resources

  • Dependency: docs/tasks/task_<ID>.md (Previous task that this builds upon)
  • Reference: README.md (Project overview and architecture)
  • Standards: CONTRIBUTING.md (Coding guidelines and conventions)
  • Similar: <PATH/TO/SIMILAR/CODE> (Example implementation to reference)
  • Documentation: <URL> (External documentation if needed)

📦 Deliverables

  • <MODULE>/<FEATURE>.py (Created)
  • tests/test_<FEATURE>.py (Created)
  • docs/<FEATURE>.md (Created)
  • <OTHER_FILE> (Modified)