2.4 KiB
2.4 KiB
Task Format Specification
Basic Structure
## Implementation Tasks
- [ ] **Task Title** `priority:N` `phase:PHASE` `deps:Dep1,Dep2`
- files: file1.py, file2.py
- [ ] Acceptance criterion 1
- [ ] Acceptance criterion 2
Task Line
- [ ] **Task Title** `priority:1` `phase:model` `deps:Other Task`
| Component | Required | Description |
|---|---|---|
- [ ] |
Yes | Checkbox (unchecked) |
**Title** |
Yes | Task title in bold |
priority:N |
No | Priority 1-10 (default: 5, lower = higher) |
phase:X |
No | Phase: model, api, ui, test, docs |
deps:A,B |
No | Comma-separated dependency task titles |
Task Details (Indented)
Files Line
- files: src/models/user.py, tests/test_user.py
Comma-separated list of files to create/modify.
Acceptance Criteria
- [ ] User model has email field
- [ ] Password hashing uses bcrypt
Checkboxes for each acceptance criterion. All must be checked for task to be complete.
Failure Reason (Auto-added)
- reason: Database connection failed
Added automatically when task is marked as failed.
Status Markers
| Status | Checkbox | Marker |
|---|---|---|
| Pending | - [ ] |
(none) |
| Completed | - [x] |
✅ |
| Failed | - [x] |
❌ |
Priority Order
- Lower priority number = execute first
- Dependencies must be completed first
- Tasks with unsatisfied dependencies are "blocked"
Examples
Pending Task
- [ ] **Create User model** `priority:1` `phase:model`
- files: src/models/user.py
- [ ] User model has email and password_hash fields
- [ ] Email validation implemented
Completed Task
- [x] **Create User model** `priority:1` `phase:model` ✅
- files: src/models/user.py
- [x] User model has email and password_hash fields
- [x] Email validation implemented
Failed Task
- [x] **Create User model** `priority:1` `phase:model` ❌
- files: src/models/user.py
- [ ] User model has email and password_hash fields
- reason: bcrypt package not installed
Task with Dependencies
- [ ] **Create auth API** `priority:3` `phase:api` `deps:Create User model,Implement JWT`
- files: src/api/auth.py
- [ ] POST /register endpoint
- [ ] POST /login endpoint
This task will not be selected by next until both "Create User model" and "Implement JWT" are completed.