Create and manage Epics - collections of related issues for major feature areas. Use when starting a new project(big feature), organizing work into themes, or adding reference documents.
Create and manage Epics for organizing related issues.
project/
āāā specs/
āāā epics/
ā āāā cli/
ā ā āāā epic.md # Epic overview and issue references
ā ā āāā progress.md # Sprint progress tracking
ā ā āāā references/ # Reference documents
ā ā āāā Design.md
ā āāā website/
ā āāā epic.md
ā āāā progress.md
ā āāā references/
āāā issues/
āāā ...
An Epic is a collection of related issues grouped by major feature area or project.
Components:
epic.md - Overview, goals, and issue referencesprogress.md - Sprint progress tracking logreferences/ - Design docs, specs, requirementsmkdir -p specs/epics/epic-name/references
# [Epic Title]
Brief description of what this epic encompasses.
## Overview
High-level goals and scope of this epic.
## Key Features
1. Feature area 1
2. Feature area 2
3. Feature area 3
## Related Issues
| Issue | Title | Status |
|-------|-------|--------|
| task01-xxx | Description | pending |
| task02-xxx | Description | pending |
## Progress
See [progress.md](progress.md) for sprint tracking.
## References
- [Design.md](references/Design.md) - Main design specification
# [Epic Name] Progress
## Current Status
Brief status description.
## In Progress
- [ ] issue-id - Description
## Completed Sprints
### [Sprint Name]
- [x] issue-id - Description
#### [YYYY-MM-DD] Session #N
- Working on: issue-id
- Completed: F001, F002
- Notes:
- What was done
- Decisions made
Copy or create reference documents in specs/epics/epic-name/references/:
git add specs/epics/epic-name/
git commit -m "feat: create epic-name epic"
Update the "Related Issues" table in epic.md:
| Issue | Title | Status |
|-------|-------|--------|
| task01-xxx | Description | completed |
| task02-xxx | Description | in-progress |
| task03-xxx | New issue | pending |
Add session entries to progress.md:
#### [YYYY-MM-DD] Session #N
- Working on: issue-id
- Completed: F001, F002, F003
- Commits: abc123
- Notes:
- Brief description of work done
Copy new reference documents to references/ and update epic.md:
## References
- [Design.md](references/Design.md) - Main design specification
- [API.md](references/API.md) - API documentation
epic.md and progress.mdepic.md when issues completeprogress.md