@flydocs/cli 0.6.0-alpha.3 → 0.6.0-alpha.30

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.
Files changed (151) hide show
  1. package/dist/cli.js +2054 -470
  2. package/package.json +1 -1
  3. package/template/.claude/CLAUDE.md +43 -48
  4. package/template/.claude/agents/implementation-agent.md +1 -1
  5. package/template/.claude/agents/pm-agent.md +1 -1
  6. package/template/.claude/commands/activate.md +1 -1
  7. package/template/.claude/commands/attach.md +1 -1
  8. package/template/.claude/commands/block.md +2 -2
  9. package/template/.claude/commands/capture.md +1 -1
  10. package/template/.claude/commands/close.md +1 -1
  11. package/template/.claude/commands/flydocs-setup.md +359 -72
  12. package/template/.claude/commands/flydocs-upgrade.md +26 -27
  13. package/template/.claude/commands/implement.md +1 -1
  14. package/template/.claude/commands/knowledge.md +61 -0
  15. package/template/.claude/commands/new-project.md +1 -1
  16. package/template/.claude/commands/onboard.md +275 -0
  17. package/template/.claude/commands/project-update.md +1 -1
  18. package/template/.claude/commands/refine.md +1 -1
  19. package/template/.claude/commands/review.md +1 -1
  20. package/template/.claude/commands/start-session.md +1 -1
  21. package/template/.claude/commands/status.md +1 -1
  22. package/template/.claude/commands/validate.md +1 -1
  23. package/template/.claude/commands/wrap-session.md +1 -1
  24. package/template/.claude/hooks/auto-approve.py +212 -0
  25. package/template/.claude/hooks/post-pr-check.py +108 -0
  26. package/template/.claude/hooks/post-transition-check.py +281 -0
  27. package/template/.claude/hooks/prompt-submit.py +554 -0
  28. package/template/.claude/hooks/session-start.py +262 -0
  29. package/template/.claude/hooks/stop-gate.py +162 -0
  30. package/template/.claude/settings.json +41 -4
  31. package/template/.claude/skills/README.md +23 -25
  32. package/template/.claude/skills/flydocs-workflow/SKILL.md +134 -42
  33. package/template/.claude/skills/flydocs-workflow/cursor-rule.mdc +9 -8
  34. package/template/.claude/skills/flydocs-workflow/reference/comment-templates.md +1 -0
  35. package/template/.claude/skills/flydocs-workflow/reference/golden-rules.md +28 -17
  36. package/template/.claude/skills/flydocs-workflow/reference/graph-schema.md +116 -0
  37. package/template/.claude/skills/flydocs-workflow/reference/pr-workflow.md +120 -0
  38. package/template/.claude/skills/flydocs-workflow/reference/priority-estimates.md +37 -15
  39. package/template/.claude/skills/flydocs-workflow/reference/service-descriptor-schema.md +260 -0
  40. package/template/.claude/skills/flydocs-workflow/reference/status-workflow.md +26 -26
  41. package/template/.claude/skills/flydocs-workflow/scripts/_local/__init__.py +0 -0
  42. package/template/.claude/skills/{flydocs-local/scripts/flydocs_api.py → flydocs-workflow/scripts/_local/file_store.py} +137 -47
  43. package/template/.claude/skills/flydocs-workflow/scripts/flydocs_api.py +724 -0
  44. package/template/{.flydocs → .claude/skills/flydocs-workflow}/scripts/generate_manifest.py +4 -4
  45. package/template/.claude/skills/{flydocs-context-graph → flydocs-workflow}/scripts/graph_build.py +132 -1
  46. package/template/.claude/skills/{flydocs-context-graph → flydocs-workflow}/scripts/graph_query.py +18 -5
  47. package/template/.claude/skills/{flydocs-context-graph → flydocs-workflow}/scripts/graph_session.py +1 -10
  48. package/template/.claude/skills/{flydocs-context-graph → flydocs-workflow}/scripts/graph_update.py +4 -4
  49. package/template/.claude/skills/{flydocs-context-graph → flydocs-workflow}/scripts/graph_utils.py +2 -1
  50. package/template/.claude/skills/flydocs-workflow/scripts/issues.py +738 -0
  51. package/template/.claude/skills/flydocs-workflow/scripts/projects.py +144 -0
  52. package/template/.claude/skills/flydocs-workflow/scripts/pull_services.py +128 -0
  53. package/template/.claude/skills/flydocs-workflow/scripts/push_service.py +132 -0
  54. package/template/.claude/skills/flydocs-workflow/scripts/session.py +54 -0
  55. package/template/.claude/skills/flydocs-workflow/scripts/test_enforcement.py +225 -0
  56. package/template/.claude/skills/flydocs-workflow/scripts/workspace.py +902 -0
  57. package/template/.claude/skills/flydocs-workflow/session.md +87 -29
  58. package/template/.claude/skills/flydocs-workflow/stages/activate.md +18 -7
  59. package/template/.claude/skills/flydocs-workflow/stages/capture.md +10 -5
  60. package/template/.claude/skills/flydocs-workflow/stages/close.md +4 -3
  61. package/template/.claude/skills/flydocs-workflow/stages/implement.md +33 -9
  62. package/template/.claude/skills/flydocs-workflow/stages/refine.md +22 -6
  63. package/template/.claude/skills/flydocs-workflow/stages/review.md +16 -4
  64. package/template/.claude/skills/flydocs-workflow/stages/validate.md +3 -1
  65. package/template/.claude/skills/flydocs-workflow/templates/pr/default.md +33 -0
  66. package/template/.cursor/agents/implementation-agent.md +1 -1
  67. package/template/.cursor/agents/pm-agent.md +2 -2
  68. package/template/.cursor/hooks.json +10 -3
  69. package/template/.env.example +6 -6
  70. package/template/.flydocs/config.json +5 -18
  71. package/template/.flydocs/templates/README.md +13 -14
  72. package/template/.flydocs/templates/bug.md +17 -153
  73. package/template/.flydocs/templates/chore.md +10 -98
  74. package/template/.flydocs/templates/feature.md +12 -158
  75. package/template/.flydocs/templates/idea.md +11 -111
  76. package/template/.flydocs/templates/quick-capture.md +4 -8
  77. package/template/.flydocs/version +1 -1
  78. package/template/AGENTS.md +44 -32
  79. package/template/CHANGELOG.md +37 -0
  80. package/template/flydocs/README.md +1 -3
  81. package/template/flydocs/context/project.md +6 -3
  82. package/template/flydocs/design-system/README.md +3 -3
  83. package/template/flydocs/knowledge/INDEX.md +38 -53
  84. package/template/flydocs/knowledge/README.md +60 -9
  85. package/template/flydocs/knowledge/templates/decision.md +47 -0
  86. package/template/flydocs/knowledge/templates/feature.md +35 -0
  87. package/template/flydocs/knowledge/templates/note.md +25 -0
  88. package/template/manifest.json +24 -20
  89. package/template/.claude/skills/flydocs-cloud/SKILL.md +0 -113
  90. package/template/.claude/skills/flydocs-cloud/cursor-rule.mdc +0 -50
  91. package/template/.claude/skills/flydocs-cloud/scripts/assign.py +0 -22
  92. package/template/.claude/skills/flydocs-cloud/scripts/assign_cycle.py +0 -28
  93. package/template/.claude/skills/flydocs-cloud/scripts/assign_milestone.py +0 -22
  94. package/template/.claude/skills/flydocs-cloud/scripts/comment.py +0 -29
  95. package/template/.claude/skills/flydocs-cloud/scripts/create_issue.py +0 -66
  96. package/template/.claude/skills/flydocs-cloud/scripts/create_milestone.py +0 -35
  97. package/template/.claude/skills/flydocs-cloud/scripts/create_project.py +0 -33
  98. package/template/.claude/skills/flydocs-cloud/scripts/create_team.py +0 -39
  99. package/template/.claude/skills/flydocs-cloud/scripts/estimate.py +0 -29
  100. package/template/.claude/skills/flydocs-cloud/scripts/flydocs_api.py +0 -210
  101. package/template/.claude/skills/flydocs-cloud/scripts/get_issue.py +0 -24
  102. package/template/.claude/skills/flydocs-cloud/scripts/link.py +0 -28
  103. package/template/.claude/skills/flydocs-cloud/scripts/list_cycles.py +0 -28
  104. package/template/.claude/skills/flydocs-cloud/scripts/list_issues.py +0 -44
  105. package/template/.claude/skills/flydocs-cloud/scripts/list_labels.py +0 -19
  106. package/template/.claude/skills/flydocs-cloud/scripts/list_milestones.py +0 -28
  107. package/template/.claude/skills/flydocs-cloud/scripts/list_projects.py +0 -31
  108. package/template/.claude/skills/flydocs-cloud/scripts/list_providers.py +0 -19
  109. package/template/.claude/skills/flydocs-cloud/scripts/list_teams.py +0 -19
  110. package/template/.claude/skills/flydocs-cloud/scripts/priority.py +0 -29
  111. package/template/.claude/skills/flydocs-cloud/scripts/project_update.py +0 -45
  112. package/template/.claude/skills/flydocs-cloud/scripts/set_labels.py +0 -68
  113. package/template/.claude/skills/flydocs-cloud/scripts/set_provider.py +0 -46
  114. package/template/.claude/skills/flydocs-cloud/scripts/set_team.py +0 -41
  115. package/template/.claude/skills/flydocs-cloud/scripts/transition.py +0 -26
  116. package/template/.claude/skills/flydocs-cloud/scripts/update_description.py +0 -36
  117. package/template/.claude/skills/flydocs-cloud/scripts/update_issue.py +0 -82
  118. package/template/.claude/skills/flydocs-context-graph/SKILL.md +0 -87
  119. package/template/.claude/skills/flydocs-context-graph/schema.md +0 -78
  120. package/template/.claude/skills/flydocs-context-graph/scripts/graph_context.py +0 -338
  121. package/template/.claude/skills/flydocs-context7/SKILL.md +0 -105
  122. package/template/.claude/skills/flydocs-context7/cursor-rule.mdc +0 -49
  123. package/template/.claude/skills/flydocs-context7/scripts/context7.py +0 -293
  124. package/template/.claude/skills/flydocs-estimates/SKILL.md +0 -384
  125. package/template/.claude/skills/flydocs-figma/SKILL.md +0 -377
  126. package/template/.claude/skills/flydocs-figma/references/PROMPTING.md +0 -108
  127. package/template/.claude/skills/flydocs-figma/references/TROUBLESHOOTING.md +0 -112
  128. package/template/.claude/skills/flydocs-local/SKILL.md +0 -103
  129. package/template/.claude/skills/flydocs-local/cursor-rule.mdc +0 -43
  130. package/template/.claude/skills/flydocs-local/scripts/assign.py +0 -20
  131. package/template/.claude/skills/flydocs-local/scripts/comment.py +0 -27
  132. package/template/.claude/skills/flydocs-local/scripts/create_issue.py +0 -44
  133. package/template/.claude/skills/flydocs-local/scripts/estimate.py +0 -37
  134. package/template/.claude/skills/flydocs-local/scripts/get_issue.py +0 -20
  135. package/template/.claude/skills/flydocs-local/scripts/link.py +0 -41
  136. package/template/.claude/skills/flydocs-local/scripts/list_issues.py +0 -34
  137. package/template/.claude/skills/flydocs-local/scripts/priority.py +0 -37
  138. package/template/.claude/skills/flydocs-local/scripts/project_update.py +0 -67
  139. package/template/.claude/skills/flydocs-local/scripts/status_summary.py +0 -16
  140. package/template/.claude/skills/flydocs-local/scripts/transition.py +0 -24
  141. package/template/.claude/skills/flydocs-local/scripts/update_description.py +0 -35
  142. package/template/.claude/skills/flydocs-local/scripts/update_issue.py +0 -84
  143. package/template/.flydocs/hooks/auto-approve.py +0 -71
  144. package/template/.flydocs/hooks/prompt-submit.py +0 -277
  145. package/template/.flydocs/scripts/skill_manager.py +0 -541
  146. /package/template/{.flydocs → .claude}/hooks/post-edit.py +0 -0
  147. /package/template/.claude/skills/{flydocs-estimates/references → flydocs-workflow/reference}/provider-costs.md +0 -0
  148. /package/template/.claude/skills/flydocs-workflow/templates/{bug.md → issues/bug.md} +0 -0
  149. /package/template/.claude/skills/flydocs-workflow/templates/{chore.md → issues/chore.md} +0 -0
  150. /package/template/.claude/skills/flydocs-workflow/templates/{feature.md → issues/feature.md} +0 -0
  151. /package/template/.claude/skills/flydocs-workflow/templates/{idea.md → issues/idea.md} +0 -0
@@ -1,18 +1,17 @@
1
1
  {
2
- "version": "0.6.0-alpha.3",
2
+ "version": "0.6.0-alpha.30",
3
3
  "sourceRepo": "github.com/plastrlab/flydocs-core",
4
4
  "tier": "local",
5
5
  "setupComplete": false,
6
+ "onboardComplete": false,
7
+ "workspaceId": null,
6
8
  "paths": {
7
9
  "content": "flydocs"
8
10
  },
9
- "provider": {
10
- "type": null,
11
- "teamId": null
12
- },
13
11
  "workspace": {
14
12
  "activeProjects": [],
15
13
  "defaultMilestoneId": null,
14
+ "repoSlug": null,
16
15
  "product": {
17
16
  "name": null,
18
17
  "labelIds": [],
@@ -21,7 +20,7 @@
21
20
  }
22
21
  },
23
22
  "issueLabels": {
24
- "_note": "Run /flydocs-setup to populate these from your Linear team",
23
+ "_note": "Run /flydocs-setup to populate these from your workspace",
25
24
  "category": {
26
25
  "feature": null,
27
26
  "bug": null,
@@ -50,18 +49,6 @@
50
49
  "installed": [],
51
50
  "custom": []
52
51
  },
53
- "statusMapping": {
54
- "BACKLOG": "Backlog",
55
- "READY": "Todo",
56
- "IMPLEMENTING": "In Progress",
57
- "BLOCKED": "Blocked",
58
- "REVIEW": "In Review",
59
- "TESTING": "QA",
60
- "COMPLETE": "Done",
61
- "ARCHIVED": "Archived",
62
- "CANCELED": "Canceled",
63
- "DUPLICATE": "Duplicate"
64
- },
65
52
  "designSystem": null,
66
53
  "aiLabor": {
67
54
  "enabled": false,
@@ -1,31 +1,33 @@
1
1
  # Issue Templates
2
2
 
3
- This folder contains templates for creating and refining Linear issues. Each template includes agent instructions to ensure consistent, high-quality issue structure.
3
+ This folder contains templates for creating and refining issues. Each template includes agent instructions to ensure consistent, high-quality issue structure.
4
4
 
5
5
  ## Template Usage
6
6
 
7
7
  **Agents use these templates when:**
8
+
8
9
  - Creating new issues via `/capture`
9
10
  - Refining issues via `/refine`
10
11
  - Triaging quick captures with `triage` label
11
12
 
12
- **Humans use `quick-capture.md` in Linear** as the default template for fast idea/bug capture.
13
+ **Humans use `quick-capture.md` in their issue tracker** as the default template for fast idea/bug capture.
13
14
 
14
15
  ## Available Templates
15
16
 
16
- | Template | Purpose | When to Use |
17
- |----------|---------|-------------|
18
- | `feature.md` | New functionality | Building something new with user story |
19
- | `bug.md` | Fix defects | Something is broken |
20
- | `chore.md` | Maintenance/cleanup | Refactoring, polish, improvements |
21
- | `idea.md` | Capture concepts | Rough ideas for future exploration |
22
- | `quick-capture.md` | Fast capture | Human entry in Linear (default template) |
17
+ | Template | Purpose | When to Use |
18
+ | ------------------ | ------------------- | ----------------------------------------------- |
19
+ | `feature.md` | New functionality | Building something new with user story |
20
+ | `bug.md` | Fix defects | Something is broken |
21
+ | `chore.md` | Maintenance/cleanup | Refactoring, polish, improvements |
22
+ | `idea.md` | Capture concepts | Rough ideas for future exploration |
23
+ | `quick-capture.md` | Fast capture | Human entry in issue tracker (default template) |
23
24
 
24
25
  ## Agent Instructions
25
26
 
26
- Each template contains `<!-- AGENT: ... -->` comments that guide the AI when filling out sections. These instructions are removed from the final issue in Linear.
27
+ Each template contains `<!-- AGENT: ... -->` comments that guide the AI when filling out sections. These instructions are removed from the final issue in your provider.
27
28
 
28
29
  **Key principles:**
30
+
29
31
  1. Fill all `[bracketed]` sections with specific content
30
32
  2. Don't remove sections - mark as "N/A" if not applicable
31
33
  3. Be specific in acceptance criteria (testable, measurable)
@@ -35,12 +37,9 @@ Each template contains `<!-- AGENT: ... -->` comments that guide the AI when fil
35
37
  ## Template Evolution
36
38
 
37
39
  Update these templates as your workflow evolves:
40
+
38
41
  - Add sections that are consistently needed
39
42
  - Remove sections that are never used
40
43
  - Improve agent instructions based on what works
41
44
 
42
45
  Changes here apply to all future issues.
43
-
44
-
45
-
46
-
@@ -1,166 +1,30 @@
1
- <!-- AGENT INSTRUCTIONS
2
- When creating or refining a bug issue:
1
+ <!-- AGENT: Use this template when creating bug issues. Fill all [bracketed] sections. -->
3
2
 
4
- 1. CONTEXT SECTION:
5
- - Capture when/how the bug was discovered
6
- - Assess user impact (how many affected, how severe)
7
- - Note frequency (always, sometimes, specific conditions)
3
+ ## What
8
4
 
9
- 2. BUG DESCRIPTION:
10
- - Expected vs Actual must be crystal clear
11
- - Steps to reproduce must be detailed enough for anyone to follow
12
- - Include specific data conditions if relevant
13
- - Note environment details (browser, OS, user role)
5
+ [One sentence describing the bug]
14
6
 
15
- 3. ACCEPTANCE CRITERIA:
16
- - "Fix Verification" should mirror the reproduction steps
17
- - Include regression concerns (what else might break)
18
- - Tests section should include regression test requirement
7
+ ## Expected Behavior
19
8
 
20
- 4. TECHNICAL NOTES:
21
- - Start with hypothesis if cause unknown
22
- - Update "Confirmed Cause" after investigation
23
- - Include specific file/function where bug exists
24
- - Assess risk of the fix
9
+ [What should happen]
25
10
 
26
- 5. SEVERITY GUIDANCE:
27
- - Critical: System unusable, data loss, security issue
28
- - High: Major feature broken, no workaround
29
- - Medium: Feature impaired but workaround exists
30
- - Low: Minor issue, cosmetic, edge case
11
+ ## Actual Behavior
31
12
 
32
- Remove these instructions when creating the final issue.
33
- -->
13
+ [What actually happens]
34
14
 
35
- ## Context
36
-
37
- **When Discovered:** [Date or event when bug was found]
38
- **Discovered By:** [User, developer, automated test, etc.]
39
- **Impact:** [How this affects users - be specific about scope]
40
- **Frequency:** [Always | Sometimes | Rarely | Under specific conditions]
41
-
42
- [Additional context about the bug]
43
-
44
- ---
45
-
46
- ## Bug Description
47
-
48
- ### Expected Behavior
49
- [Describe what SHOULD happen - the correct behavior]
50
-
51
- ### Actual Behavior
52
- [Describe what ACTUALLY happens - the broken behavior]
53
-
54
- ### Steps to Reproduce
55
- 1. [First action - be specific]
56
- 2. [Second action - include any data/conditions needed]
57
- 3. [Third action]
58
- 4. [Observe the bug]
59
-
60
- ### Environment
61
- - **Browser/Platform:** [Chrome, Safari, Mobile, etc.]
62
- - **OS:** [macOS, Windows, iOS, Android, etc.]
63
- - **User Role:** [Which user type experiences this]
64
- - **Data Conditions:** [Specific data state that triggers bug]
65
-
66
- ### Screenshots/Evidence
67
- <!-- Add as attachments -->
15
+ ## Steps to Reproduce
68
16
 
69
- ---
17
+ 1. [Step 1]
18
+ 2. [Step 2]
19
+ 3. [Step 3]
70
20
 
71
21
  ## Acceptance Criteria
72
22
 
73
- ### Fix Verification
74
- - [ ] Bug no longer reproducible using original steps
75
- - [ ] Expected behavior now works correctly
76
- - [ ] Fix doesn't break related functionality
77
- - [ ] No new error messages or console errors
78
-
79
- ### Tests
80
- - [ ] Regression test added to prevent recurrence
81
- - [ ] Related edge cases tested
82
- - [ ] All tests passing
83
-
84
- ### Documentation
85
- - [ ] Root cause documented (if significant pattern)
86
- - [ ] Prevention notes added to knowledge base (if applicable)
87
- - [ ] N/A - No significant documentation needed
88
-
89
- ---
90
-
91
- ## Technical Notes
92
-
93
- ### Root Cause Analysis
94
- **Hypothesis:** [What you think is causing the bug]
95
-
96
- **Investigation Findings:**
97
- - [Finding 1 from debugging]
98
- - [Finding 2 from debugging]
99
-
100
- **Confirmed Cause:** [What's actually wrong - file, function, logic error]
101
-
102
- ### Fix Approach
103
- [Describe the fix strategy - what needs to change]
104
-
105
- **Files to Modify:**
106
- - `path/to/file.tsx` - [What needs to change]
107
-
108
- **Risk Assessment:**
109
- - **Regression Risk:** Low | Medium | High
110
- - **Testing Required:** [What needs to be tested]
111
-
112
- ---
113
-
114
- ## Dependencies
115
-
116
- **Related Systems:**
117
- - [System or feature where bug occurs]
118
-
119
- **Blocks:**
120
- - [Work that can't proceed until bug is fixed]
121
- - OR: Nothing blocked
122
-
123
- **Related Bugs:**
124
- - [Link to related bug if applicable]
125
- - OR: No related issues
126
-
127
- ---
128
-
129
- ## AI Effort Estimate
130
- <!--
131
- AGENT: Fill this section during /refine using the flydocs-estimates skill.
132
- See .claude/skills/flydocs-estimates/SKILL.md for calculation details.
133
- Update Actuals section during /close for calibration.
134
- -->
135
-
136
- ### Sizing Factors
137
-
138
- | Factor | Value | Multiplier |
139
- |--------|-------|------------|
140
- | **Task Type** | bug | base: 20k |
141
- | **Scope** | [S/M/L/XL] | ×[0.5/1.0/2.0/4.0] |
142
- | **Novelty** | [existing/partial/greenfield] | ×[0.7/1.2/2.0] |
143
- | **Clarity** | [defined/discovery/exploratory] | ×[0.8/1.5/2.5] |
144
- | **Codebase** | [simple/moderate/complex] | ×[0.8/1.0/1.5] |
145
-
146
- ### Estimate
147
-
148
- **Provider**: [Claude Sonnet 4]
149
- **Calculated Tokens**: ~[X]k
150
- **Confidence**: ±[40-60]%
151
- **Token Range**: [low]k - [high]k
152
- **Cost Range**: $[low] - $[high]
153
-
154
- ### Actuals (fill on /close)
155
- **Actual Tokens**: [fill after completion]
156
- **Variance**: [+/-X]% [under/over estimate]
157
- **Notes**: [what drove variance - investigation time, fix complexity, retries]
158
-
159
- ---
160
-
161
- _Reported: YYYY-MM-DD_
162
-
163
-
164
-
23
+ - [ ] Bug is fixed and original behavior restored
24
+ - [ ] [Additional verification criteria]
165
25
 
26
+ ## Context
166
27
 
28
+ - **Frequency:** [Always / Sometimes / Rare]
29
+ - **Impact:** [Blocking / Degraded / Cosmetic]
30
+ - **Environment:** [Where it occurs — browser, OS, tier]
@@ -1,110 +1,22 @@
1
- <!-- AGENT INSTRUCTIONS
2
- When creating or refining a chore issue:
1
+ <!-- AGENT: Use this template when creating chore issues. Fill all [bracketed] sections. -->
3
2
 
4
- 1. CONTEXT SECTION:
5
- - Explain the value (cleaner code, better UX, faster performance)
6
- - Be specific about scope to prevent scope creep
7
- - Mark as "Ongoing" if this is iterative work
3
+ ## What
8
4
 
9
- 2. TASK LIST:
10
- - Be specific and actionable
11
- - Add tasks as you discover them during work
12
- - Move tasks to "Out of Scope" if they're too big
13
- - Tasks should be completable in one session
5
+ [One sentence describing the task]
14
6
 
15
- 3. ACCEPTANCE CRITERIA:
16
- - Focus on completion and quality
17
- - Mark documentation as N/A if no new patterns
18
- - Mark tests as N/A if no behavior changes
7
+ ## Why
19
8
 
20
- 4. COMPLETION CRITERIA:
21
- - "Done when" should be clear stopping point
22
- - If scope keeps growing, suggest splitting into multiple chores
23
-
24
- 5. WORKFLOW:
25
- - Chores often skip formal review/QA
26
- - Use simplified flow: Backlog → In Progress → Done
27
- - Use full flow only for significant refactors
28
-
29
- Remove these instructions when creating the final issue.
30
- -->
31
-
32
- ## Context
33
-
34
- **Why This Matters:**
35
- [Explanation of the value - cleaner code, better UX, faster performance, etc.]
36
-
37
- **Scope:**
38
- [What areas/pages/features does this touch? Be specific enough to stay focused.]
39
-
40
- **Type:** Ongoing | One-time
41
-
42
- ---
43
-
44
- ## Task List
45
-
46
- ### Initial Tasks
47
- - [ ] [Task 1 - be specific]
48
- - [ ] [Task 2 - be specific]
49
- - [ ] [Task 3 - be specific]
50
-
51
- ### Added During Work
52
- <!-- Add new tasks discovered while working -->
53
-
54
- ### Out of Scope
55
- <!-- Tasks that don't fit - might become new issues -->
56
- - [Task that's too big or different focus]
57
-
58
- ---
9
+ [Why this maintenance/cleanup is needed now]
59
10
 
60
11
  ## Acceptance Criteria
61
12
 
62
- ### Completion
63
- - [ ] All initial tasks completed (or moved to out of scope)
64
- - [ ] Code quality acceptable
65
- - [ ] No regressions introduced
66
-
67
- ### Tests
68
- - [ ] Tests updated if behavior changed
69
- - [ ] All tests passing
70
- - [ ] N/A - No behavior changes
13
+ - [ ] [Specific, testable criterion 1]
14
+ - [ ] [Specific, testable criterion 2]
71
15
 
72
- ### Documentation
73
- - [ ] Patterns documented (if new approach discovered)
74
- - [ ] N/A - No significant documentation needed
16
+ ## Scope
75
17
 
76
- ---
18
+ [What's included and what's explicitly excluded]
77
19
 
78
20
  ## Technical Notes
79
21
 
80
- ### Approach
81
- [How you'll tackle this work]
82
-
83
- ### Files to Touch
84
- - `path/to/file.tsx` - [What changes]
85
-
86
- ### Risk Assessment
87
- - **Regression Risk:** Low | Medium | High
88
- - **Related Areas:** [What else might be affected]
89
-
90
- ---
91
-
92
- ## Completion Criteria
93
-
94
- **This chore is done when:**
95
- - [ ] [Completion criterion 1]
96
- - [ ] [Completion criterion 2]
97
- - [ ] No obvious improvements remaining in scope
98
-
99
- **Signs this needs to be split:**
100
- - Work has been ongoing for 3+ weeks
101
- - Scope has grown significantly
102
- - New tasks are unrelated to original purpose
103
-
104
- ---
105
-
106
- _Created: YYYY-MM-DD_
107
-
108
-
109
-
110
-
22
+ [Approach, risks, or migration steps — remove if not applicable]
@@ -1,173 +1,27 @@
1
- <!-- AGENT INSTRUCTIONS
2
- When creating or refining a feature issue:
1
+ <!-- AGENT: Use this template when creating feature issues. Fill all [bracketed] sections. -->
3
2
 
4
- 1. CONTEXT SECTION:
5
- - Explain the problem being solved, not just the solution
6
- - Include business value or user impact
7
- - Reference project goals from {content-folder}/context/overview.md if relevant
3
+ ## What
8
4
 
9
- 2. USER STORY:
10
- - Must follow "As a... I want... So that..." format
11
- - Be specific about the user role (not just "user")
12
- - Benefit should be concrete and measurable
13
- - Include an example scenario for clarity
5
+ [One sentence describing the feature]
14
6
 
15
- 3. ACCEPTANCE CRITERIA:
16
- - Each criterion must be testable and specific
17
- - Use checkboxes for tracking completion
18
- - Include error handling scenarios
19
- - "Must Have" = required for completion
20
- - "Should Have" = nice to have, not blocking
21
- - "Won't Have" = explicitly out of scope
7
+ ## Why
22
8
 
23
- 4. TECHNICAL NOTES:
24
- - Reference patterns from {content-folder}/context/stack.md
25
- - List specific components/files to create or modify
26
- - Include data model changes if applicable
27
- - Note any API changes needed
28
-
29
- 5. DEPENDENCIES:
30
- - List issues that must be completed first
31
- - Note what future work this enables
32
-
33
- Remove these instructions when creating the final issue.
34
- -->
35
-
36
- ## Context
37
-
38
- [Problem description - what user pain or business need does this address?]
39
-
40
- **Current Issues:**
41
- - [Issue or limitation 1]
42
- - [Issue or limitation 2]
43
-
44
- ---
9
+ [Problem this solves or opportunity it creates]
45
10
 
46
11
  ## User Story
47
12
 
48
- **As a** [specific user role]
49
- **I want to** [specific goal or action]
50
- **So that** [concrete benefit or outcome]
51
-
52
- **Example Scenario:**
53
- [Real-world scenario where this feature would be used]
54
-
55
- ---
13
+ As a [role], I want to [action] so that [benefit].
56
14
 
57
15
  ## Acceptance Criteria
58
16
 
59
- ### Must Have
60
- - [ ] [Specific, measurable criterion 1]
61
- - [ ] [User can perform X action and see Y result]
62
- - [ ] [System behaves correctly when Z happens]
63
- - [ ] [Error handling: System shows helpful message when...]
64
-
65
- ### Should Have
66
- - [ ] [Nice-to-have enhancement]
67
-
68
- ### Won't Have (Out of Scope)
69
- - [Explicitly excluded functionality]
70
-
71
- ### Tests
72
- - [ ] Tests written for core functionality
73
- - [ ] Edge cases and error scenarios covered
74
- - [ ] All tests passing
75
-
76
- ### Documentation
77
- - [ ] Code documented (comments on complex logic)
78
- - [ ] Knowledge base updated (if significant decisions/patterns)
79
- - [ ] Context files updated (if architecture changes)
80
- - [ ] N/A - No significant documentation needed
81
-
82
- ---
17
+ - [ ] [Specific, testable criterion 1]
18
+ - [ ] [Specific, testable criterion 2]
19
+ - [ ] [Specific, testable criterion 3]
83
20
 
84
21
  ## Technical Notes
85
22
 
86
- ### Implementation Approach
87
- [High-level description of how this will be built]
88
-
89
- **Key Technical Decisions:**
90
- 1. [Decision 1 and rationale]
91
- 2. [Decision 2 and rationale]
92
-
93
- ### Components Needed
94
- **New:**
95
- - `ComponentName` - [What it does]
96
-
97
- **Modify:**
98
- - `ExistingComponent` - [What changes needed]
99
-
100
- ### Data Model
101
- ```typescript
102
- // Schema changes if any
103
- // OR: No data model changes required
104
- ```
105
-
106
- ### API Endpoints
107
- - `POST /api/endpoint` - [Description]
108
- - OR: No new endpoints required
109
-
110
- ---
111
-
112
- ## Dependencies
113
-
114
- **Required Before Starting:**
115
- - [Feature or system that must exist first]
116
- - OR: No dependencies - can start immediately
117
-
118
- **Enables Future Work:**
119
- - [Feature that depends on this being complete]
120
-
121
- ---
122
-
123
- ## Design Reference
124
- <!-- Add Figma links as attachments -->
125
-
126
- ---
127
-
128
- ## AI Effort Estimate
129
- <!--
130
- AGENT: Fill this section during /refine using the flydocs-estimates skill.
131
- See .claude/skills/flydocs-estimates/SKILL.md for calculation details.
132
- Update Actuals section during /close for calibration.
133
- -->
134
-
135
- ### Sizing Factors
136
-
137
- | Factor | Value | Multiplier |
138
- |--------|-------|------------|
139
- | **Task Type** | feature | base: 40k |
140
- | **Scope** | [S/M/L/XL] | ×[0.5/1.0/2.0/4.0] |
141
- | **Novelty** | [existing/partial/greenfield] | ×[0.7/1.2/2.0] |
142
- | **Clarity** | [defined/discovery/exploratory] | ×[0.8/1.5/2.5] |
143
- | **Codebase** | [simple/moderate/complex] | ×[0.8/1.0/1.5] |
144
-
145
- ### Estimate
146
-
147
- **Provider**: [Claude Sonnet 4]
148
- **Calculated Tokens**: ~[X]k
149
- **Confidence**: ±[40-60]%
150
- **Token Range**: [low]k - [high]k
151
- **Cost Range**: $[low] - $[high]
152
-
153
- ### Approach Comparison
154
-
155
- | Approach | Est. Cost | Est. Time | Recommendation |
156
- |----------|-----------|-----------|----------------|
157
- | **Full AI** | $[X] | [X] hrs | [When to use] |
158
- | **AI-Assisted** | $[X] + [X]hrs | [X] hrs | [When to use] |
159
- | **Human-Led** | $[X] (review) | [X] hrs | [When to use] |
160
-
161
- ### Actuals (fill on /close)
162
- **Actual Tokens**: [fill after completion]
163
- **Variance**: [+/-X]% [under/over estimate]
164
- **Notes**: [what drove variance - blockers, scope changes, retries]
165
-
166
- ---
167
-
168
- _Created: YYYY-MM-DD_
169
-
170
-
171
-
23
+ [Implementation approach, constraints, or dependencies — remove if not applicable]
172
24
 
25
+ ## Out of Scope
173
26
 
27
+ [Explicitly list what this does NOT include — remove if not applicable]