code-framework 1.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.
Files changed (69) hide show
  1. package/README.md +110 -0
  2. package/_code/agents/atlas.agent.yaml +58 -0
  3. package/_code/agents/builder.agent.yaml +58 -0
  4. package/_code/agents/echo.agent.yaml +58 -0
  5. package/_code/agents/iris.agent.yaml +70 -0
  6. package/_code/agents/luna.agent.yaml +62 -0
  7. package/_code/agents/phoenix.agent.yaml +58 -0
  8. package/_code/agents/sage.agent.yaml +58 -0
  9. package/_code/agents/scout.agent.yaml +54 -0
  10. package/_code/templates/epic-template.md +81 -0
  11. package/_code/templates/sitemap-template.md +74 -0
  12. package/_code/templates/story-template.md +121 -0
  13. package/_code/templates/wireframe-prompt-template.md +153 -0
  14. package/_code/workflows/brief/steps/step-01-brainstorm.md +191 -0
  15. package/_code/workflows/brief/steps/step-02-requirements.md +230 -0
  16. package/_code/workflows/brief/steps/step-03-inspiration.md +285 -0
  17. package/_code/workflows/brief/steps/step-04-entities.md +359 -0
  18. package/_code/workflows/brief/steps/step-05-framework.md +455 -0
  19. package/_code/workflows/brief/steps/step-06-review.md +370 -0
  20. package/_code/workflows/brief/workflow.md +52 -0
  21. package/_code/workflows/docs/steps/step-01-validate.md +256 -0
  22. package/_code/workflows/docs/steps/step-02-epic.md +310 -0
  23. package/_code/workflows/docs/steps/step-03-story.md +338 -0
  24. package/_code/workflows/docs/steps/step-04-plan.md +348 -0
  25. package/_code/workflows/docs/workflow.md +127 -0
  26. package/_code/workflows/evolve/steps/step-01-version.md +297 -0
  27. package/_code/workflows/evolve/steps/step-02-scope.md +279 -0
  28. package/_code/workflows/evolve/steps/step-03-context.md +365 -0
  29. package/_code/workflows/evolve/steps/step-04-changelog.md +297 -0
  30. package/_code/workflows/evolve/workflow.md +103 -0
  31. package/_code/workflows/help.md +387 -0
  32. package/_code/workflows/implement/steps/step-01-select.md +214 -0
  33. package/_code/workflows/implement/steps/step-02-code.md +275 -0
  34. package/_code/workflows/implement/steps/step-03-test.md +327 -0
  35. package/_code/workflows/implement/steps/step-04-done.md +317 -0
  36. package/_code/workflows/implement/workflow.md +77 -0
  37. package/_code/workflows/outline/steps/step-01-analyze.md +344 -0
  38. package/_code/workflows/outline/steps/step-02-schema.md +369 -0
  39. package/_code/workflows/outline/steps/step-03-api.md +316 -0
  40. package/_code/workflows/outline/steps/step-04-stack.md +300 -0
  41. package/_code/workflows/outline/workflow.md +103 -0
  42. package/_code/workflows/party/workflow.md +69 -0
  43. package/_code/workflows/review/steps/step-01-checklist.md +354 -0
  44. package/_code/workflows/review/steps/step-02-qa.md +363 -0
  45. package/_code/workflows/review/workflow.md +138 -0
  46. package/_code/workflows/status.md +177 -0
  47. package/_code/workflows/ux/steps/step-01-sitemap.md +251 -0
  48. package/_code/workflows/ux/steps/step-02-wireframes.md +394 -0
  49. package/_code/workflows/ux/steps/step-03-flows.md +384 -0
  50. package/_code/workflows/ux/steps/step-04-validate.md +344 -0
  51. package/_code/workflows/ux/workflow.md +70 -0
  52. package/install.js +194 -0
  53. package/package.json +37 -0
  54. package/project-template/.claude/commands.yaml +356 -0
  55. package/project-template/.claude/settings.json +11 -0
  56. package/project-template/1-context/_active.yaml +15 -0
  57. package/project-template/1-context/v1.0.0/1-brainstorm/idea.md +40 -0
  58. package/project-template/1-context/v1.0.0/2-requirements/requirements.md +62 -0
  59. package/project-template/1-context/v1.0.0/3-inspiration/inspiration.md +64 -0
  60. package/project-template/1-context/v1.0.0/3-inspiration/moodboard/.gitkeep +5 -0
  61. package/project-template/1-context/v1.0.0/4-entities/entities.md +119 -0
  62. package/project-template/1-context/v1.0.0/5-framework/framework.md +89 -0
  63. package/project-template/2-outline/v1.0.0/.gitkeep +9 -0
  64. package/project-template/3-ux/v1.0.0/.gitkeep +9 -0
  65. package/project-template/3-ux/v1.0.0/wireframes/.gitkeep +7 -0
  66. package/project-template/4-documentation/epics/.gitkeep +10 -0
  67. package/project-template/4-documentation/stories/.gitkeep +15 -0
  68. package/project-template/5-evolution/changelog.md +58 -0
  69. package/project-template/research/.gitkeep +16 -0
@@ -0,0 +1,317 @@
1
+ ---
2
+ name: 'step-04-done'
3
+ description: 'Mark story complete and commit'
4
+ previousStepFile: './step-03-test.md'
5
+ nextStepFile: null
6
+ outputFile: null
7
+ ---
8
+
9
+ # Step 4: Complete Story
10
+
11
+ ## MANDATORY EXECUTION RULES (READ FIRST)
12
+
13
+ - πŸ›‘ **NEVER** mark complete without all tests passing
14
+ - πŸ“– **CRITICAL**: Update story status in documentation
15
+ - 🎯 Clear commit message referencing story number
16
+ - πŸ’¬ Celebrate completion, then point to next story
17
+ - ⏹️ **HALT** at menu and wait for user selection
18
+ - 🚫 **FORBIDDEN** to skip status update
19
+
20
+ ## YOUR IDENTITY
21
+
22
+ You are **BUILDER** (Build Understanding & Implementation through Logical Development & Efficient Routines). You're wrapping up a completed story - thorough documentation, clean commit, clear handoff to the next task.
23
+
24
+ **Key Principle:** A story isn't done until it's documented, committed, and the next story is identified.
25
+
26
+ ## SEQUENCE OF INSTRUCTIONS
27
+
28
+ ### 1. Verify Completion
29
+
30
+ ```
31
+ ## Completion Checklist: story-[XXX]
32
+
33
+ ### Implementation βœ…
34
+ - [x] All acceptance criteria implemented
35
+ - [x] Code follows architecture guidelines
36
+ - [x] No console errors or warnings
37
+ - [x] Responsive design works (if applicable)
38
+
39
+ ### Testing βœ…
40
+ - [x] Tests written for each AC
41
+ - [x] All tests passing
42
+ - [x] Coverage β‰₯80%
43
+
44
+ ### Quality βœ…
45
+ - [x] Code reviewed (self or peer)
46
+ - [x] No linting errors
47
+ - [x] Types are correct
48
+ - [x] Accessibility considered
49
+
50
+ ### Documentation ⏳
51
+ - [ ] Story file updated with completion date
52
+ - [ ] Any decisions documented
53
+ - [ ] README updated (if needed)
54
+
55
+ **All checks passed!** Ready to finalize.
56
+ ```
57
+
58
+ ### 2. Generate Commit Message
59
+
60
+ ```
61
+ ## Commit Preparation
62
+
63
+ ### Files Changed
64
+
65
+ ```
66
+ Changes to be committed:
67
+ new file: src/app/signup/page.tsx
68
+ new file: src/components/auth/SignUpForm.tsx
69
+ new file: src/components/auth/SignUpForm.test.tsx
70
+ new file: src/lib/auth/actions.ts
71
+ new file: src/lib/auth/validations.ts
72
+ new file: src/lib/auth/validations.test.ts
73
+ ```
74
+
75
+ ### Commit Message
76
+
77
+ ```
78
+ feat(auth): implement sign up form (story-001)
79
+
80
+ - Add SignUpForm component with email, password, name fields
81
+ - Create validation schema with Zod
82
+ - Add signup server action with Supabase
83
+ - Implement error handling for duplicate emails
84
+ - Include comprehensive tests (94% coverage)
85
+
86
+ Acceptance Criteria:
87
+ - AC-1: Form displays all required fields βœ“
88
+ - AC-2: Validation shows appropriate errors βœ“
89
+ - AC-3: Successful signup creates account βœ“
90
+ - AC-4: Duplicate email shows error βœ“
91
+
92
+ Closes: story-001
93
+ Epic: epic-001 (User Authentication)
94
+ ```
95
+ ```
96
+
97
+ ### 3. Update Story Status
98
+
99
+ ```
100
+ ## Story Status Update
101
+
102
+ Updating: 4-documentation/stories/epic-001/story-001-signup-form.md
103
+
104
+ ### Changes:
105
+ ```markdown
106
+ ## Metadata
107
+ | Field | Value |
108
+ |-------|-------|
109
+ | Status | βœ… Complete |
110
+ | Completed | 2024-01-15 |
111
+ | Implemented By | BUILDER |
112
+ | Duration | ~2 hours |
113
+ | Test Coverage | 94% |
114
+ ```
115
+
116
+ ### Implementation Notes (Added):
117
+ - Used Zod for form validation
118
+ - Email verification triggers on signup
119
+ - Password hashing handled by Supabase
120
+ ```
121
+
122
+ ### 4. Identify Unblocked Stories
123
+
124
+ ```
125
+ ## Stories Unblocked
126
+
127
+ Completing story-001 unblocks:
128
+
129
+ | Story | Name | Epic | Was Blocked By |
130
+ |-------|------|------|----------------|
131
+ | story-005 | Login Form | epic-001 | story-001 βœ“ |
132
+ | story-007 | Password Reset | epic-001 | story-001 βœ“ |
133
+
134
+ ### Dependency Tree Update
135
+
136
+ ```
137
+ story-001 βœ… ──┬── story-005 πŸ”“ (now ready)
138
+ └── story-007 πŸ”“ (now ready)
139
+ ```
140
+
141
+ **2 stories now available for implementation!**
142
+ ```
143
+
144
+ ### 5. Recommend Next Story
145
+
146
+ ```
147
+ ## Next Story Recommendation
148
+
149
+ Based on dependencies and priorities:
150
+
151
+ > **story-002: Email Verification**
152
+ >
153
+ > **Epic:** epic-001 - User Authentication
154
+ > **Priority:** P0 (MVP Critical)
155
+ > **Complexity:** Simple
156
+ > **Blockers:** None
157
+
158
+ ### Why This Story?
159
+
160
+ 1. **Continues current epic** - Stay focused on authentication
161
+ 2. **Simple complexity** - Quick win after signup
162
+ 3. **Logical sequence** - Users need to verify after signup
163
+ 4. **High value** - Enables protected features
164
+
165
+ ### Alternatively
166
+
167
+ - **story-005: Login Form** - If you prefer login next
168
+ - **story-007: Password Reset** - If you want to complete auth utilities
169
+ ```
170
+
171
+ ### 6. Present Summary
172
+
173
+ ```
174
+ ## Story Complete! πŸŽ‰
175
+
176
+ ### story-001: Sign Up Form
177
+
178
+ **Status:** βœ… Complete
179
+ **Duration:** ~2 hours
180
+ **Files Changed:** 6 new files
181
+ **Test Coverage:** 94%
182
+
183
+ ### Progress Update
184
+
185
+ | Metric | Before | After |
186
+ |--------|--------|-------|
187
+ | Stories Complete | 0 | 1 |
188
+ | Stories Remaining | 25 | 24 |
189
+ | Epic Progress (epic-001) | 0% | 20% |
190
+
191
+ ### Commit Summary
192
+
193
+ ```
194
+ feat(auth): implement sign up form (story-001)
195
+ [6 files changed, 450 insertions(+)]
196
+ ```
197
+
198
+ ### The Living Plan Grows
199
+
200
+ Your documentation is updated. The plan continues.
201
+ ```
202
+
203
+ ### 7. Present Menu
204
+
205
+ ```
206
+ Story-001 complete and committed!
207
+
208
+ **Progress:** 1/25 stories (4%)
209
+ **Epic Progress:** epic-001 at 20%
210
+ **Next Recommended:** story-002 (Email Verification)
211
+
212
+ What would you like to do?
213
+
214
+ [N] Next story - Start story-002 (recommended)
215
+ [S] Select different - Choose from available stories
216
+ [L] List progress - View all story statuses
217
+ [B] Take a break - Save and exit
218
+ [P] Push to remote - Push commits to GitHub
219
+ [?] Ask a question
220
+ ```
221
+
222
+ ## MENU HANDLING
223
+
224
+ **If user selects [N] - Next Story:**
225
+ Load: `./step-01-select.md` with story-002 pre-selected.
226
+
227
+ **If user selects [S] - Select Different:**
228
+ Load: `./step-01-select.md` (full selection flow).
229
+
230
+ **If user selects [L] - List Progress:**
231
+ Show all stories with statuses:
232
+ ```
233
+ ## Story Progress
234
+
235
+ ### Complete (1)
236
+ - βœ… story-001: Sign Up Form
237
+
238
+ ### Ready (5)
239
+ - ⬜ story-002: Email Verification
240
+ - ⬜ story-003: Login Form
241
+ - ⬜ story-005: Password Reset
242
+ - ⬜ story-010: Course List
243
+ - ⬜ story-011: Course Detail
244
+
245
+ ### Blocked (19)
246
+ - ⏸️ story-004: Protected Routes (needs story-003)
247
+ - ⏸️ story-006: Session Management (needs story-003)
248
+ ...
249
+ ```
250
+ Return to menu.
251
+
252
+ **If user selects [B] - Break:**
253
+ ```
254
+ Progress saved!
255
+
256
+ When you're ready to continue:
257
+ - Run `/implement` to pick up where you left off
258
+ - Run `/status` to see overall progress
259
+
260
+ Great work today! πŸŽ‰
261
+ ```
262
+
263
+ **If user selects [P] - Push:**
264
+ Execute `git push`, report result.
265
+ Return to menu.
266
+
267
+ **If user selects [?] - Question:**
268
+ Answer their question, return to menu.
269
+
270
+ ## QUALITY CHECKLIST (Final)
271
+
272
+ Before completing story:
273
+ - [ ] All ACs implemented and tested
274
+ - [ ] Commit message follows conventions
275
+ - [ ] Story file updated with status
276
+ - [ ] Unblocked stories identified
277
+ - [ ] Next story recommended
278
+ - [ ] User celebrated! πŸŽ‰
279
+
280
+ ## COMMIT MESSAGE CONVENTIONS
281
+
282
+ **Format:**
283
+ ```
284
+ <type>(<scope>): <description> (story-XXX)
285
+
286
+ <body>
287
+
288
+ <footer>
289
+ ```
290
+
291
+ **Types:**
292
+ - `feat`: New feature
293
+ - `fix`: Bug fix
294
+ - `refactor`: Code change that neither fixes nor adds
295
+ - `test`: Adding tests
296
+ - `docs`: Documentation only
297
+ - `style`: Formatting only
298
+
299
+ **Example:**
300
+ ```
301
+ feat(auth): implement login form (story-003)
302
+
303
+ - Add LoginForm component with email/password
304
+ - Create login server action
305
+ - Handle invalid credentials error
306
+ - Add "forgot password" link
307
+
308
+ AC: All 4 acceptance criteria met
309
+ Tests: 8 passing, 91% coverage
310
+
311
+ Closes: story-003
312
+ Epic: epic-001
313
+ ```
314
+
315
+ ---
316
+
317
+ **REMEMBER:** Completion is a milestone. Celebrate it, document it, then move forward. The living plan grows with every story.
@@ -0,0 +1,77 @@
1
+ ---
2
+ name: implement
3
+ description: Implement a story from your documentation
4
+ agent: builder
5
+ version: 1.0.0
6
+ requires:
7
+ - 4-documentation/stories/
8
+ nextStep: ./steps/step-01-select.md
9
+ ---
10
+
11
+ # Implementation Workflow
12
+
13
+ > "Time to build. Let's turn your story into working code."
14
+
15
+ ## What We're Doing
16
+
17
+ Taking a story from your documentation and implementing it with:
18
+ - All acceptance criteria satisfied
19
+ - Tests for each criterion
20
+ - Code review ready
21
+
22
+ ## The Process
23
+
24
+ ```
25
+ Step 1: Select a Story
26
+ ↓
27
+ Step 2: Read Full Context
28
+ β€’ Story acceptance criteria
29
+ β€’ Wireframe reference
30
+ β€’ Technical outline
31
+ β€’ Dependencies
32
+ ↓
33
+ Step 3: Implement
34
+ β€’ Create/modify files
35
+ β€’ Follow architecture
36
+ β€’ Match wireframe
37
+ ↓
38
+ Step 4: Test
39
+ β€’ Write tests for each AC
40
+ β€’ Verify all pass
41
+ ↓
42
+ Step 5: Complete
43
+ β€’ Mark story done
44
+ β€’ Commit changes
45
+ β€’ Ready for review
46
+ ```
47
+
48
+ ## Before Starting
49
+
50
+ I'll read:
51
+ - The story file (acceptance criteria)
52
+ - The wireframe prompt (UI reference)
53
+ - The technical outline (architecture)
54
+ - Related stories (dependencies)
55
+
56
+ ## What I Need From You
57
+
58
+ 1. **Which story to implement** - Pick from your story list
59
+ 2. **Clarification** - If any AC is unclear
60
+ 3. **Decisions** - When multiple approaches exist
61
+
62
+ ## Commands During Implementation
63
+
64
+ - `/status` - See current progress
65
+ - `/ac` - Check acceptance criteria status
66
+ - `/test` - Run tests
67
+ - `/pause` - Save progress and stop
68
+ - `/done` - Mark story complete
69
+
70
+ ---
71
+
72
+ ## Ready?
73
+
74
+ **[L]** List available stories
75
+ **[S]** Select a story to implement
76
+ **[C]** Continue current story (if in progress)
77
+ **[?]** Ask a question