|
|
--- |
|
|
id: <TASK_ID> |
|
|
title: "<TASK_TITLE>" |
|
|
status: "Todo" |
|
|
estimate_hours: <HOURS> |
|
|
dependencies: [<DEPENDENCY_IDS>] |
|
|
tags: ["<TAG1>", "<TAG2>"] |
|
|
assignee: "<ASSIGNEE>" |
|
|
--- |
|
|
|
|
|
## 🎯 Objective |
|
|
<!-- One sentence that answers "Why are we doing this?" --> |
|
|
<OBJECTIVE> |
|
|
|
|
|
## 📋 Requirements |
|
|
<!-- Clear, specific, measurable requirements. What needs to be created/changed? --> |
|
|
- <REQUIREMENT_1> |
|
|
- <REQUIREMENT_2> |
|
|
- <REQUIREMENT_3> |
|
|
|
|
|
## 🛑 Constraints & Rules |
|
|
<!-- Non-negotiable rules and boundaries --> |
|
|
- 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`) |
|
|
- <SPECIFIC_CONSTRAINT> |
|
|
|
|
|
## ✅ Acceptance Criteria (Definition of Done) |
|
|
<!-- Verifiable checklist - each item must be testable with a specific command --> |
|
|
- [ ] 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` |
|
|
- [ ] <SPECIFIC_CRITERION> |
|
|
|
|
|
## 📚 Context & Resources |
|
|
<!-- Resources that provide necessary context for this task --> |
|
|
- **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 |
|
|
<!-- Exhaustive list of files to be created or modified --> |
|
|
- `<MODULE>/<FEATURE>.py` (Created) |
|
|
- `tests/test_<FEATURE>.py` (Created) |
|
|
- `docs/<FEATURE>.md` (Created) |
|
|
- `<OTHER_FILE>` (Modified) |
|
|
|
|
|
--- |
|
|
|
|
|
<!-- |
|
|
TEMPLATE USAGE NOTES: |
|
|
1. Replace all <PLACEHOLDERS> with actual values |
|
|
2. Remove any sections that don't apply |
|
|
3. Add additional requirements/criteria as needed |
|
|
4. Be specific about file paths and commands |
|
|
5. Ensure all acceptance criteria can be verified with commands |
|
|
6. List ALL files that will be touched in Deliverables |
|
|
--> |
