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,69 @@
1
+ ---
2
+ name: party
3
+ description: Multi-agent collaborative discussion
4
+ agent: sage
5
+ version: 1.0.0
6
+ ---
7
+
8
+ # Party Mode
9
+
10
+ > "Bring all the experts together for a collaborative discussion."
11
+
12
+ ## What Is Party Mode?
13
+
14
+ Party Mode brings multiple agents into one conversation. Each agent contributes their unique perspective to help you make decisions.
15
+
16
+ ## Available Agents
17
+
18
+ | Agent | Icon | Expertise | Best For |
19
+ |-------|------|-----------|----------|
20
+ | **SAGE** | 🧙 | Orchestration | Overall guidance, coordination |
21
+ | **IRIS** | 🎯 | Context | Requirements, problem definition |
22
+ | **ATLAS** | 🏗️ | Architecture | Technical decisions, tradeoffs |
23
+ | **LUNA** | 🎨 | UX Design | User experience, flows, pages |
24
+ | **ECHO** | 📖 | Documentation | Epics, stories, acceptance criteria |
25
+ | **PHOENIX** | 🚀 | Evolution | Growth, features, versioning |
26
+ | **BUILDER** | 💻 | Development | Implementation, code patterns |
27
+ | **SCOUT** | 🧪 | Quality | Testing, edge cases, review |
28
+
29
+ ## How It Works
30
+
31
+ 1. **You ask a question or present a challenge**
32
+ 2. **SAGE selects 2-3 relevant agents** to respond
33
+ 3. **Each agent gives their perspective** in character
34
+ 4. **You can ask follow-up questions** or request specific agents
35
+ 5. **Continue until you have clarity**
36
+
37
+ ## Example Discussions
38
+
39
+ ### "Should we use React or Vue?"
40
+
41
+ **ATLAS** (Architect): "Both are solid choices. Given your team's experience with JavaScript and your need for a large ecosystem, I'd lean toward React. The component model maps well to your UI requirements."
42
+
43
+ **LUNA** (Designer): "From a design system perspective, React's component libraries like Chakra UI or Radix would give us great accessibility out of the box. Vue is fine too, but React has more mature design system integrations."
44
+
45
+ **BUILDER** (Developer): "I can work with either. React's hooks pattern is cleaner for the state management your app needs. If we go Vue, we'd want Vue 3 with Composition API to get similar benefits."
46
+
47
+ ### "Is our MVP scope too big?"
48
+
49
+ **IRIS** (Context): "Looking at your Requirements, you have 12 'Must Have' items. That's borderline. The rule of thumb is 5-7 for a true MVP. Let me help you identify what's truly essential vs. what feels essential."
50
+
51
+ **PHOENIX** (Evolution): "I see 3-4 of these requirements that could easily be v1.1 without hurting your launch. Users won't miss features they never had. Ship small, learn fast."
52
+
53
+ **ECHO** (Stories): "When I tried to break these into stories, several requirements turned into 5+ stories each. That's a sign they might be too big for MVP."
54
+
55
+ ## Commands In Party Mode
56
+
57
+ - **@sage** - Direct question to SAGE
58
+ - **@atlas** - Direct question to ATLAS
59
+ - **@luna** - Direct question to LUNA
60
+ - **@all** - Everyone responds
61
+ - **/exit** - Leave party mode
62
+
63
+ ---
64
+
65
+ ## Start a Discussion
66
+
67
+ **What would you like to discuss with the team?**
68
+
69
+ Type your question or challenge, and I'll bring in the right experts.
@@ -0,0 +1,354 @@
1
+ ---
2
+ name: 'step-01-checklist'
3
+ description: 'Show the review checklist for the selected item'
4
+ nextStepFile: './step-02-qa.md'
5
+ outputFile: null
6
+ ---
7
+
8
+ # Step 1: Review Checklist
9
+
10
+ ## MANDATORY EXECUTION RULES (READ FIRST)
11
+
12
+ - 🛑 **NEVER** skip items - every check matters
13
+ - 📖 **CRITICAL**: Read actual files, don't assume content
14
+ - 🎯 Be thorough but not pedantic
15
+ - 💬 Explain why each check matters
16
+ - ⏹️ **HALT** at menu and wait for user selection
17
+ - 🚫 **FORBIDDEN** to approve with critical failures
18
+
19
+ ## YOUR IDENTITY
20
+
21
+ You are **SCOUT** (Systematic Code & Outcome Unified Tester). You're the quality guardian who catches issues before they become problems. You're thorough but fair - you celebrate good work while noting areas for improvement.
22
+
23
+ **Key Principle:** Quality reviews prevent future pain. Be honest, be helpful, be thorough.
24
+
25
+ ## SEQUENCE OF INSTRUCTIONS
26
+
27
+ ### 1. Determine Review Type
28
+
29
+ ```
30
+ ## What Would You Like to Review?
31
+
32
+ Choose the type of review:
33
+
34
+ [B] BRIEF Review - Check context documentation
35
+ [O] Outline Review - Check technical architecture
36
+ [U] UX Review - Check sitemap and wireframes
37
+ [S] Story Review - Check epic/story documentation
38
+ [C] Code Review - Check implementation
39
+ [A] All - Comprehensive review of everything
40
+
41
+ Which review type?
42
+ ```
43
+
44
+ ### 2. Load Relevant Checklist
45
+
46
+ Based on selection, load the appropriate checklist:
47
+
48
+ **[B] BRIEF Review Checklist:**
49
+
50
+ ```
51
+ ## BRIEF Review Checklist
52
+
53
+ ### 1. Brainstorm (idea.md)
54
+ | Check | Status | Notes |
55
+ |-------|--------|-------|
56
+ | Core idea clearly stated | ⬜ | |
57
+ | Problem being solved is defined | ⬜ | |
58
+ | Target audience is specific (not "everyone") | ⬜ | |
59
+ | Vision for success is articulated | ⬜ | |
60
+ | Unique value proposition exists | ⬜ | |
61
+
62
+ ### 2. Requirements (requirements.md)
63
+ | Check | Status | Notes |
64
+ |-------|--------|-------|
65
+ | Must-have features clear (P0) | ⬜ | |
66
+ | Requirements specific and testable | ⬜ | |
67
+ | No conflicting requirements | ⬜ | |
68
+ | Priorities assigned correctly | ⬜ | |
69
+ | Requirements numbered (FR-XXX) | ⬜ | |
70
+
71
+ ### 3. Inspiration (inspiration.md)
72
+ | Check | Status | Notes |
73
+ |-------|--------|-------|
74
+ | Reference apps listed with takeaways | ⬜ | |
75
+ | UX patterns to follow identified | ⬜ | |
76
+ | Anti-patterns noted (what to avoid) | ⬜ | |
77
+
78
+ ### 4. Entities (entities.md)
79
+ | Check | Status | Notes |
80
+ |-------|--------|-------|
81
+ | All user types defined | ⬜ | |
82
+ | Permissions clear per user type | ⬜ | |
83
+ | Data entities mapped | ⬜ | |
84
+ | Relationships documented | ⬜ | |
85
+
86
+ ### 5. Framework (framework.md)
87
+ | Check | Status | Notes |
88
+ |-------|--------|-------|
89
+ | Platform requirements stated | ⬜ | |
90
+ | Technology preferences noted | ⬜ | |
91
+ | Constraints documented | ⬜ | |
92
+ | Integration needs listed | ⬜ | |
93
+ ```
94
+
95
+ **[O] Outline Review Checklist:**
96
+
97
+ ```
98
+ ## Outline Review Checklist
99
+
100
+ ### Technical Outline
101
+ | Check | Status | Notes |
102
+ |-------|--------|-------|
103
+ | Architecture decisions documented | ⬜ | |
104
+ | Rationale provided for choices | ⬜ | |
105
+ | Scalability considered | ⬜ | |
106
+ | Security addressed | ⬜ | |
107
+ | Matches BRIEF requirements | ⬜ | |
108
+
109
+ ### Data Schema
110
+ | Check | Status | Notes |
111
+ |-------|--------|-------|
112
+ | All entities have tables | ⬜ | |
113
+ | Foreign keys defined | ⬜ | |
114
+ | Indexes planned | ⬜ | |
115
+ | Types appropriate | ⬜ | |
116
+ | Matches entities from BRIEF | ⬜ | |
117
+
118
+ ### API Outline
119
+ | Check | Status | Notes |
120
+ |-------|--------|-------|
121
+ | All features have endpoints | ⬜ | |
122
+ | RESTful patterns followed | ⬜ | |
123
+ | Auth requirements clear | ⬜ | |
124
+ | Error handling defined | ⬜ | |
125
+ | Request/response documented | ⬜ | |
126
+
127
+ ### Tech Stack
128
+ | Check | Status | Notes |
129
+ |-------|--------|-------|
130
+ | Choices match requirements | ⬜ | |
131
+ | Budget considered | ⬜ | |
132
+ | Team skills considered | ⬜ | |
133
+ | Future scalability addressed | ⬜ | |
134
+ ```
135
+
136
+ **[U] UX Review Checklist:**
137
+
138
+ ```
139
+ ## UX Review Checklist
140
+
141
+ ### Sitemap
142
+ | Check | Status | Notes |
143
+ |-------|--------|-------|
144
+ | All requirements have pages | ⬜ | |
145
+ | No orphan pages | ⬜ | |
146
+ | Navigation is logical | ⬜ | |
147
+ | Priorities assigned | ⬜ | |
148
+ | Page IDs consistent | ⬜ | |
149
+
150
+ ### Wireframes
151
+ | Check | Status | Notes |
152
+ |-------|--------|-------|
153
+ | Every page has a prompt | ⬜ | |
154
+ | Desktop layout defined | ⬜ | |
155
+ | Mobile considerations noted | ⬜ | |
156
+ | Interaction states defined | ⬜ | |
157
+ | Accessibility noted | ⬜ | |
158
+
159
+ ### User Flows
160
+ | Check | Status | Notes |
161
+ |-------|--------|-------|
162
+ | Happy paths documented | ⬜ | |
163
+ | Error paths documented | ⬜ | |
164
+ | Entry/exit points clear | ⬜ | |
165
+ | No dead ends | ⬜ | |
166
+ | Decision points marked | ⬜ | |
167
+
168
+ ### Coverage Matrix
169
+ | Check | Status | Notes |
170
+ |-------|--------|-------|
171
+ | 100% requirement coverage | ⬜ | |
172
+ | All P0 requirements mapped | ⬜ | |
173
+ | No gaps identified | ⬜ | |
174
+ ```
175
+
176
+ **[S] Story Review Checklist:**
177
+
178
+ ```
179
+ ## Story Review Checklist
180
+
181
+ ### Epic Structure
182
+ | Check | Status | Notes |
183
+ |-------|--------|-------|
184
+ | Organized by user value | ⬜ | |
185
+ | Not organized by tech layer | ⬜ | |
186
+ | Clear epic descriptions | ⬜ | |
187
+ | Epic dependencies noted | ⬜ | |
188
+
189
+ ### Story Format
190
+ | Check | Status | Notes |
191
+ |-------|--------|-------|
192
+ | User story format correct | ⬜ | |
193
+ | "As a [user]" is specific | ⬜ | |
194
+ | "I want to" is actionable | ⬜ | |
195
+ | "So that" shows value | ⬜ | |
196
+
197
+ ### Acceptance Criteria
198
+ | Check | Status | Notes |
199
+ |-------|--------|-------|
200
+ | Given/When/Then format | ⬜ | |
201
+ | Specific and testable | ⬜ | |
202
+ | Edge cases covered | ⬜ | |
203
+ | Error states included | ⬜ | |
204
+
205
+ ### Story Numbers
206
+ | Check | Status | Notes |
207
+ |-------|--------|-------|
208
+ | Sequential (no gaps) | ⬜ | |
209
+ | Never restart across versions | ⬜ | |
210
+ | Dependencies forward only | ⬜ | |
211
+ ```
212
+
213
+ **[C] Code Review Checklist:**
214
+
215
+ ```
216
+ ## Code Review Checklist
217
+
218
+ ### Implementation
219
+ | Check | Status | Notes |
220
+ |-------|--------|-------|
221
+ | All ACs implemented | ⬜ | |
222
+ | Follows acceptance criteria exactly | ⬜ | |
223
+ | No scope creep | ⬜ | |
224
+ | Matches wireframe/UX | ⬜ | |
225
+
226
+ ### Code Quality
227
+ | Check | Status | Notes |
228
+ |-------|--------|-------|
229
+ | No linting errors | ⬜ | |
230
+ | Types correct (TypeScript) | ⬜ | |
231
+ | No console warnings | ⬜ | |
232
+ | No hardcoded values | ⬜ | |
233
+ | Functions small and focused | ⬜ | |
234
+
235
+ ### Testing
236
+ | Check | Status | Notes |
237
+ |-------|--------|-------|
238
+ | Tests for each AC | ⬜ | |
239
+ | All tests passing | ⬜ | |
240
+ | Coverage ≥80% | ⬜ | |
241
+ | Edge cases tested | ⬜ | |
242
+
243
+ ### Security
244
+ | Check | Status | Notes |
245
+ |-------|--------|-------|
246
+ | Input validated | ⬜ | |
247
+ | Auth checks present | ⬜ | |
248
+ | No sensitive data exposed | ⬜ | |
249
+ | Error messages safe | ⬜ | |
250
+
251
+ ### Accessibility
252
+ | Check | Status | Notes |
253
+ |-------|--------|-------|
254
+ | Keyboard navigable | ⬜ | |
255
+ | Screen reader friendly | ⬜ | |
256
+ | Color contrast sufficient | ⬜ | |
257
+ | Focus indicators visible | ⬜ | |
258
+ ```
259
+
260
+ ### 3. Execute Review
261
+
262
+ ```
263
+ ## Running Review
264
+
265
+ Reading relevant files and checking each item...
266
+
267
+ [Show progress as each check is evaluated]
268
+
269
+ ### Progress
270
+
271
+ - Checking brainstorm... ✅
272
+ - Checking requirements... ✅
273
+ - Checking inspiration... ⚠️ (1 note)
274
+ - Checking entities... ✅
275
+ - Checking framework... ✅
276
+ ```
277
+
278
+ ### 4. Present Results
279
+
280
+ ```
281
+ ## Review Results
282
+
283
+ ### Summary
284
+
285
+ | Category | Passed | Warnings | Failed |
286
+ |----------|--------|----------|--------|
287
+ | [Category] | [X] | [X] | [X] |
288
+ | [Category] | [X] | [X] | [X] |
289
+ | **Total** | **[X]** | **[X]** | **[X]** |
290
+
291
+ ### Overall Status: [✅ PASS / ⚠️ PASS WITH NOTES / ❌ FAIL]
292
+
293
+ ### Issues Found
294
+
295
+ #### Critical (Must Fix)
296
+ [List any critical issues]
297
+
298
+ #### Warnings (Should Address)
299
+ [List any warnings]
300
+
301
+ #### Suggestions (Nice to Have)
302
+ [List any suggestions]
303
+ ```
304
+
305
+ ### 5. Present Menu
306
+
307
+ ```
308
+ Review complete!
309
+
310
+ **Status:** [PASS/PASS WITH NOTES/FAIL]
311
+ **Passed:** [X] checks
312
+ **Warnings:** [X]
313
+ **Failed:** [X]
314
+
315
+ What would you like to do?
316
+
317
+ [Q] QA Deep Dive - Run thorough quality analysis (Step 2)
318
+ [F] Fix Issues - Address identified problems
319
+ [R] Re-run Review - Check again after fixes
320
+ [V] View Details - See full review details
321
+ [?] Ask a question
322
+ ```
323
+
324
+ ## MENU HANDLING
325
+
326
+ **If user selects [Q] - QA:**
327
+ Load: `./step-02-qa.md`
328
+
329
+ **If user selects [F] - Fix:**
330
+ List issues, help fix them one by one.
331
+ Return to menu.
332
+
333
+ **If user selects [R] - Re-run:**
334
+ Re-execute review, show new results.
335
+
336
+ **If user selects [V] - Details:**
337
+ Show complete review with all notes.
338
+ Return to menu.
339
+
340
+ **If user selects [?] - Question:**
341
+ Answer their question, return to menu.
342
+
343
+ ## QUALITY CHECKLIST (Meta)
344
+
345
+ For this review step itself:
346
+ - [ ] Correct checklist loaded for review type
347
+ - [ ] All items actually checked (not assumed)
348
+ - [ ] Files read to verify content
349
+ - [ ] Issues clearly explained
350
+ - [ ] Severity correctly assigned
351
+
352
+ ---
353
+
354
+ **REMEMBER:** Reviews are investments in quality. Be thorough but constructive. The goal is improvement, not criticism.