@comfanion/workflow 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +185 -0
- package/bin/cli.js +406 -0
- package/package.json +50 -0
- package/src/build-info.json +16 -0
- package/src/opencode/ARCHITECTURE.md +255 -0
- package/src/opencode/FLOW.yaml +900 -0
- package/src/opencode/agents/analyst.md +141 -0
- package/src/opencode/agents/architect.md +177 -0
- package/src/opencode/agents/change-manager.md +263 -0
- package/src/opencode/agents/dev.md +171 -0
- package/src/opencode/agents/module-docs.md +628 -0
- package/src/opencode/agents/pm.md +157 -0
- package/src/opencode/agents/researcher.md +254 -0
- package/src/opencode/agents/sm.md +184 -0
- package/src/opencode/agents/workflow-orchestrator.md +249 -0
- package/src/opencode/checklists/architecture-checklist.md +166 -0
- package/src/opencode/checklists/code-review-checklist.md +151 -0
- package/src/opencode/checklists/prd-checklist.md +140 -0
- package/src/opencode/checklists/requirements-checklist.md +86 -0
- package/src/opencode/checklists/story-checklist.md +137 -0
- package/src/opencode/commands/architecture.md +68 -0
- package/src/opencode/commands/archive.md +146 -0
- package/src/opencode/commands/change.md +169 -0
- package/src/opencode/commands/clarify.md +132 -0
- package/src/opencode/commands/code-review.md +96 -0
- package/src/opencode/commands/coding-standards.md +102 -0
- package/src/opencode/commands/dev-story.md +80 -0
- package/src/opencode/commands/diagram.md +152 -0
- package/src/opencode/commands/epics.md +52 -0
- package/src/opencode/commands/help.md +139 -0
- package/src/opencode/commands/jira-sync.md +58 -0
- package/src/opencode/commands/module-docs.md +158 -0
- package/src/opencode/commands/prd.md +63 -0
- package/src/opencode/commands/quick.md +166 -0
- package/src/opencode/commands/requirements.md +49 -0
- package/src/opencode/commands/research.md +113 -0
- package/src/opencode/commands/sprint-plan.md +59 -0
- package/src/opencode/commands/stories.md +61 -0
- package/src/opencode/commands/validate.md +84 -0
- package/src/opencode/commands/workflow-status.md +150 -0
- package/src/opencode/config.yaml +223 -0
- package/src/opencode/opencode.json +36 -0
- package/src/opencode/skills/acceptance-criteria/SKILL.md +212 -0
- package/src/opencode/skills/adr-writing/SKILL.md +241 -0
- package/src/opencode/skills/architecture-design/SKILL.md +183 -0
- package/src/opencode/skills/architecture-validation/SKILL.md +199 -0
- package/src/opencode/skills/archiving/SKILL.md +191 -0
- package/src/opencode/skills/changelog/SKILL.md +280 -0
- package/src/opencode/skills/code-review/SKILL.md +193 -0
- package/src/opencode/skills/coding-standards/SKILL.md +430 -0
- package/src/opencode/skills/diagram-creation/SKILL.md +273 -0
- package/src/opencode/skills/doc-todo/SKILL.md +325 -0
- package/src/opencode/skills/epic-writing/SKILL.md +291 -0
- package/src/opencode/skills/jira-integration/SKILL.md +560 -0
- package/src/opencode/skills/methodologies/SKILL.md +376 -0
- package/src/opencode/skills/module-documentation/SKILL.md +214 -0
- package/src/opencode/skills/prd-validation/SKILL.md +164 -0
- package/src/opencode/skills/prd-writing/SKILL.md +104 -0
- package/src/opencode/skills/requirements-gathering/SKILL.md +132 -0
- package/src/opencode/skills/requirements-validation/SKILL.md +141 -0
- package/src/opencode/skills/research-methodology/SKILL.md +140 -0
- package/src/opencode/skills/sprint-planning/SKILL.md +217 -0
- package/src/opencode/skills/story-writing/SKILL.md +574 -0
- package/src/opencode/skills/test-design/SKILL.md +313 -0
- package/src/opencode/skills/translation/SKILL.md +411 -0
- package/src/opencode/templates/CHANGELOG.md +82 -0
- package/src/opencode/templates/adr-template.md +115 -0
- package/src/opencode/templates/architecture-template.md +362 -0
- package/src/opencode/templates/change-proposal-template.md +186 -0
- package/src/opencode/templates/epic-template.md +151 -0
- package/src/opencode/templates/git-workflow-template.md +384 -0
- package/src/opencode/templates/integration-tests-template.md +265 -0
- package/src/opencode/templates/jira-cache-template.yaml +103 -0
- package/src/opencode/templates/module-index-template.md +139 -0
- package/src/opencode/templates/module-test-cases-template.md +230 -0
- package/src/opencode/templates/prd-acceptance-criteria-template.md +124 -0
- package/src/opencode/templates/prd-template.md +479 -0
- package/src/opencode/templates/requirements-template.md +132 -0
- package/src/opencode/templates/sprint-status-template.yaml +84 -0
- package/src/opencode/templates/story-template.md +437 -0
- package/src/opencode/templates/testing-standards-template.md +359 -0
- package/src/opencode/workflows/dev-story/instructions.md +529 -0
- package/src/repo-structure/.gitattributes +64 -0
- package/src/repo-structure/CONTRIBUTING.md +182 -0
- package/src/repo-structure/README.md +77 -0
- package/src/repo-structure/docs/README.md +62 -0
- package/src/repo-structure/docs/api/README.md +43 -0
- package/src/repo-structure/docs/architecture/README.md +36 -0
- package/src/repo-structure/docs/architecture/adr/README.md +53 -0
- package/src/repo-structure/docs/architecture/diagrams/README.md +59 -0
- package/src/repo-structure/docs/coding-standards/README.md +52 -0
- package/src/repo-structure/docs/confluence/README.md +43 -0
- package/src/repo-structure/docs/requirements/README.md +28 -0
- package/src/repo-structure/docs/sprint-artifacts/README.md +76 -0
- package/src/repo-structure/docs/sprint-artifacts/backlog/README.md +24 -0
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: sprint-planning
|
|
3
|
+
description: How to organize epics and stories into sprints, manage sprint-status.yaml, and track progress
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: opencode
|
|
6
|
+
metadata:
|
|
7
|
+
domain: agile
|
|
8
|
+
artifacts: docs/sprint-artifacts/sprint-status.yaml
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Sprint Planning Skill
|
|
12
|
+
|
|
13
|
+
## When to Use
|
|
14
|
+
|
|
15
|
+
Use this skill when you need to:
|
|
16
|
+
- Organize epics into sprints
|
|
17
|
+
- Create sprint-status.yaml
|
|
18
|
+
- Track sprint progress
|
|
19
|
+
- Plan new sprints
|
|
20
|
+
|
|
21
|
+
## Sprint Duration
|
|
22
|
+
|
|
23
|
+
- **Recommended:** 2 weeks
|
|
24
|
+
- **Range:** 1-4 weeks depending on team
|
|
25
|
+
- **Sprint 0:** Foundation/setup work
|
|
26
|
+
|
|
27
|
+
## Sprint Planning Process
|
|
28
|
+
|
|
29
|
+
### Step 1: Analyze Backlog
|
|
30
|
+
|
|
31
|
+
1. List all epics from `docs/sprint-artifacts/backlog/`
|
|
32
|
+
2. Check dependencies between epics
|
|
33
|
+
3. Identify P0 (must-have) epics
|
|
34
|
+
|
|
35
|
+
### Step 2: Calculate Velocity
|
|
36
|
+
|
|
37
|
+
If historical data exists:
|
|
38
|
+
- Average story points per sprint
|
|
39
|
+
- Team availability
|
|
40
|
+
|
|
41
|
+
If new project:
|
|
42
|
+
- Estimate conservatively
|
|
43
|
+
- Plan 60-70% capacity for first sprint
|
|
44
|
+
|
|
45
|
+
### Step 3: Create Sprint
|
|
46
|
+
|
|
47
|
+
1. Select epics that fit capacity
|
|
48
|
+
2. Respect dependencies (blocked epics can't start)
|
|
49
|
+
3. Balance workload across team
|
|
50
|
+
4. Define sprint goal
|
|
51
|
+
|
|
52
|
+
### Step 4: Move Epics
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
# Move epic from backlog to sprint
|
|
56
|
+
mv docs/sprint-artifacts/backlog/epic-10-*.md docs/sprint-artifacts/sprint-2/
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Step 5: Update sprint-status.yaml
|
|
60
|
+
|
|
61
|
+
## Sprint Status YAML Format
|
|
62
|
+
|
|
63
|
+
```yaml
|
|
64
|
+
# docs/sprint-artifacts/sprint-status.yaml
|
|
65
|
+
project: marketplace
|
|
66
|
+
current_sprint: sprint-1
|
|
67
|
+
updated: 2026-01-23
|
|
68
|
+
|
|
69
|
+
sprints:
|
|
70
|
+
sprint-0:
|
|
71
|
+
status: completed
|
|
72
|
+
goal: "Foundation and data layer"
|
|
73
|
+
start_date: 2026-01-06
|
|
74
|
+
end_date: 2026-01-17
|
|
75
|
+
velocity: 34 # story points completed
|
|
76
|
+
epics:
|
|
77
|
+
- id: CATALOG-E01
|
|
78
|
+
title: "Catalog Data Layer"
|
|
79
|
+
status: done
|
|
80
|
+
stories_done: 6
|
|
81
|
+
stories_total: 6
|
|
82
|
+
|
|
83
|
+
sprint-1:
|
|
84
|
+
status: in_progress
|
|
85
|
+
goal: "Core domain implementation"
|
|
86
|
+
start_date: 2026-01-20
|
|
87
|
+
end_date: 2026-02-03
|
|
88
|
+
capacity: 40 # planned story points
|
|
89
|
+
epics:
|
|
90
|
+
- id: CATALOG-E05
|
|
91
|
+
title: "Products Service"
|
|
92
|
+
status: in_progress
|
|
93
|
+
branch: feature/epic-05-products-service
|
|
94
|
+
assignee: team-catalog
|
|
95
|
+
stories:
|
|
96
|
+
- id: CATALOG-S05-01
|
|
97
|
+
title: "Product aggregate"
|
|
98
|
+
status: in_progress
|
|
99
|
+
estimate: M
|
|
100
|
+
assignee: developer-1
|
|
101
|
+
- id: CATALOG-S05-02
|
|
102
|
+
title: "Product repository"
|
|
103
|
+
status: todo
|
|
104
|
+
estimate: M
|
|
105
|
+
assignee: developer-1
|
|
106
|
+
- id: CATALOG-S05-03
|
|
107
|
+
title: "Product HTTP endpoints"
|
|
108
|
+
status: todo
|
|
109
|
+
estimate: L
|
|
110
|
+
assignee: developer-2
|
|
111
|
+
|
|
112
|
+
sprint-2:
|
|
113
|
+
status: planned
|
|
114
|
+
goal: "Search and filtering"
|
|
115
|
+
start_date: 2026-02-03
|
|
116
|
+
end_date: 2026-02-17
|
|
117
|
+
epics: [] # To be planned
|
|
118
|
+
|
|
119
|
+
backlog:
|
|
120
|
+
- id: CATALOG-E10
|
|
121
|
+
title: "Search Integration"
|
|
122
|
+
priority: P1
|
|
123
|
+
estimate: L
|
|
124
|
+
depends_on: [CATALOG-E05]
|
|
125
|
+
|
|
126
|
+
- id: INVENTORY-E01
|
|
127
|
+
title: "Inventory Management"
|
|
128
|
+
priority: P0
|
|
129
|
+
estimate: XL
|
|
130
|
+
depends_on: [CATALOG-E05]
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## Status Values
|
|
134
|
+
|
|
135
|
+
### Sprint Status
|
|
136
|
+
- `planned` - Sprint defined but not started
|
|
137
|
+
- `in_progress` - Current sprint
|
|
138
|
+
- `completed` - Sprint finished
|
|
139
|
+
|
|
140
|
+
### Epic Status
|
|
141
|
+
- `todo` - Not started
|
|
142
|
+
- `in_progress` - Work ongoing
|
|
143
|
+
- `review` - All stories done, under review
|
|
144
|
+
- `done` - Completed and merged
|
|
145
|
+
|
|
146
|
+
### Story Status
|
|
147
|
+
- `todo` - Not started
|
|
148
|
+
- `in_progress` - Being worked on
|
|
149
|
+
- `review` - PR submitted
|
|
150
|
+
- `done` - Merged
|
|
151
|
+
|
|
152
|
+
## Sprint Actions
|
|
153
|
+
|
|
154
|
+
### Start New Sprint
|
|
155
|
+
|
|
156
|
+
```yaml
|
|
157
|
+
# Add new sprint
|
|
158
|
+
sprint-2:
|
|
159
|
+
status: in_progress
|
|
160
|
+
goal: "[Sprint goal]"
|
|
161
|
+
start_date: YYYY-MM-DD
|
|
162
|
+
end_date: YYYY-MM-DD
|
|
163
|
+
epics: []
|
|
164
|
+
|
|
165
|
+
# Update current_sprint
|
|
166
|
+
current_sprint: sprint-2
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### Complete Sprint
|
|
170
|
+
|
|
171
|
+
```yaml
|
|
172
|
+
# Update sprint status
|
|
173
|
+
sprint-1:
|
|
174
|
+
status: completed
|
|
175
|
+
velocity: 38 # actual points completed
|
|
176
|
+
|
|
177
|
+
# Move incomplete work to backlog or next sprint
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### Update Progress
|
|
181
|
+
|
|
182
|
+
```yaml
|
|
183
|
+
# Update story status
|
|
184
|
+
- id: CATALOG-S05-01
|
|
185
|
+
status: done # was: in_progress
|
|
186
|
+
|
|
187
|
+
# Update epic progress
|
|
188
|
+
- id: CATALOG-E05
|
|
189
|
+
stories_done: 3 # was: 2
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
## Sprint Planning Rules
|
|
193
|
+
|
|
194
|
+
1. **Respect dependencies** - Blocked epics wait
|
|
195
|
+
2. **Don't overcommit** - Plan 70-80% capacity
|
|
196
|
+
3. **Balance skills** - Distribute work by expertise
|
|
197
|
+
4. **Include buffer** - Leave room for issues
|
|
198
|
+
5. **Clear goals** - Each sprint has measurable goal
|
|
199
|
+
|
|
200
|
+
## Sprint Review Checklist
|
|
201
|
+
|
|
202
|
+
At end of sprint:
|
|
203
|
+
- [ ] All stories marked done or moved
|
|
204
|
+
- [ ] Velocity calculated
|
|
205
|
+
- [ ] Retrospective notes added
|
|
206
|
+
- [ ] Blockers documented
|
|
207
|
+
- [ ] Next sprint planned
|
|
208
|
+
|
|
209
|
+
## Output
|
|
210
|
+
|
|
211
|
+
Update: `docs/sprint-artifacts/sprint-status.yaml`
|
|
212
|
+
|
|
213
|
+
## Related Skills
|
|
214
|
+
|
|
215
|
+
- `epic-writing` - For creating epics
|
|
216
|
+
- `story-writing` - For creating stories
|
|
217
|
+
- `jira-integration` - For syncing to Jira
|