@su-record/vibe 2.5.6 → 2.5.8

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 (188) hide show
  1. package/CLAUDE.md +338 -338
  2. package/LICENSE +21 -21
  3. package/README.md +262 -262
  4. package/agents/build-error-resolver.md +115 -0
  5. package/agents/compounder.md +261 -261
  6. package/agents/diagrammer.md +178 -178
  7. package/agents/e2e-tester.md +266 -266
  8. package/agents/explorer.md +48 -48
  9. package/agents/implementer.md +54 -54
  10. package/agents/refactor-cleaner.md +143 -0
  11. package/agents/research/best-practices-agent.md +189 -189
  12. package/agents/research/codebase-patterns-agent.md +147 -147
  13. package/agents/research/framework-docs-agent.md +178 -178
  14. package/agents/research/security-advisory-agent.md +203 -203
  15. package/agents/review/architecture-reviewer.md +107 -107
  16. package/agents/review/complexity-reviewer.md +116 -116
  17. package/agents/review/data-integrity-reviewer.md +88 -88
  18. package/agents/review/git-history-reviewer.md +103 -103
  19. package/agents/review/performance-reviewer.md +86 -86
  20. package/agents/review/python-reviewer.md +150 -150
  21. package/agents/review/rails-reviewer.md +139 -139
  22. package/agents/review/react-reviewer.md +144 -144
  23. package/agents/review/security-reviewer.md +80 -80
  24. package/agents/review/simplicity-reviewer.md +140 -140
  25. package/agents/review/test-coverage-reviewer.md +116 -116
  26. package/agents/review/typescript-reviewer.md +127 -127
  27. package/agents/searcher.md +54 -54
  28. package/agents/simplifier.md +120 -120
  29. package/agents/tester.md +49 -49
  30. package/agents/ui-previewer.md +129 -129
  31. package/commands/vibe.analyze.md +356 -356
  32. package/commands/vibe.reason.md +329 -329
  33. package/commands/vibe.review.md +326 -326
  34. package/commands/vibe.run.md +1031 -1031
  35. package/commands/vibe.spec.md +1022 -1022
  36. package/commands/vibe.utils.md +296 -202
  37. package/commands/vibe.verify.md +375 -375
  38. package/dist/cli/collaborator.js +52 -52
  39. package/dist/cli/detect.js +32 -32
  40. package/dist/cli/index.js +112 -112
  41. package/dist/cli/llm.js +144 -144
  42. package/dist/cli/mcp.d.ts +49 -0
  43. package/dist/cli/mcp.d.ts.map +1 -0
  44. package/dist/cli/mcp.js +169 -0
  45. package/dist/cli/mcp.js.map +1 -0
  46. package/dist/lib/PythonParser.js +108 -108
  47. package/dist/lib/gemini-mcp.d.ts +10 -0
  48. package/dist/lib/gemini-mcp.d.ts.map +1 -0
  49. package/dist/lib/gemini-mcp.js +353 -0
  50. package/dist/lib/gemini-mcp.js.map +1 -0
  51. package/dist/lib/gpt-api.js +4 -4
  52. package/dist/lib/gpt-mcp.d.ts +10 -0
  53. package/dist/lib/gpt-mcp.d.ts.map +1 -0
  54. package/dist/lib/gpt-mcp.js +352 -0
  55. package/dist/lib/gpt-mcp.js.map +1 -0
  56. package/dist/lib/memory/KnowledgeGraph.js +4 -4
  57. package/dist/lib/memory/MemorySearch.js +20 -20
  58. package/dist/lib/memory/MemoryStorage.js +64 -64
  59. package/dist/tools/analytics/getUsageAnalytics.d.ts +10 -0
  60. package/dist/tools/analytics/getUsageAnalytics.d.ts.map +1 -0
  61. package/dist/tools/analytics/getUsageAnalytics.js +246 -0
  62. package/dist/tools/analytics/getUsageAnalytics.js.map +1 -0
  63. package/dist/tools/analytics/index.d.ts +5 -0
  64. package/dist/tools/analytics/index.d.ts.map +1 -0
  65. package/dist/tools/analytics/index.js +5 -0
  66. package/dist/tools/analytics/index.js.map +1 -0
  67. package/dist/tools/convention/analyzeComplexity.test.js +115 -115
  68. package/dist/tools/convention/getCodingGuide.d.ts +7 -0
  69. package/dist/tools/convention/getCodingGuide.d.ts.map +1 -0
  70. package/dist/tools/convention/getCodingGuide.js +69 -0
  71. package/dist/tools/convention/getCodingGuide.js.map +1 -0
  72. package/dist/tools/convention/validateCodeQuality.test.js +104 -104
  73. package/dist/tools/planning/analyzeRequirements.d.ts +9 -0
  74. package/dist/tools/planning/analyzeRequirements.d.ts.map +1 -0
  75. package/dist/tools/planning/analyzeRequirements.js +171 -0
  76. package/dist/tools/planning/analyzeRequirements.js.map +1 -0
  77. package/dist/tools/planning/createUserStories.d.ts +9 -0
  78. package/dist/tools/planning/createUserStories.d.ts.map +1 -0
  79. package/dist/tools/planning/createUserStories.js +124 -0
  80. package/dist/tools/planning/createUserStories.js.map +1 -0
  81. package/dist/tools/planning/featureRoadmap.d.ts +10 -0
  82. package/dist/tools/planning/featureRoadmap.d.ts.map +1 -0
  83. package/dist/tools/planning/featureRoadmap.js +207 -0
  84. package/dist/tools/planning/featureRoadmap.js.map +1 -0
  85. package/dist/tools/planning/generatePrd.d.ts +11 -0
  86. package/dist/tools/planning/generatePrd.d.ts.map +1 -0
  87. package/dist/tools/planning/generatePrd.js +161 -0
  88. package/dist/tools/planning/generatePrd.js.map +1 -0
  89. package/dist/tools/planning/index.d.ts +8 -0
  90. package/dist/tools/planning/index.d.ts.map +1 -0
  91. package/dist/tools/planning/index.js +8 -0
  92. package/dist/tools/planning/index.js.map +1 -0
  93. package/dist/tools/prompt/analyzePrompt.d.ts +7 -0
  94. package/dist/tools/prompt/analyzePrompt.d.ts.map +1 -0
  95. package/dist/tools/prompt/analyzePrompt.js +150 -0
  96. package/dist/tools/prompt/analyzePrompt.js.map +1 -0
  97. package/dist/tools/prompt/enhancePrompt.d.ts +8 -0
  98. package/dist/tools/prompt/enhancePrompt.d.ts.map +1 -0
  99. package/dist/tools/prompt/enhancePrompt.js +110 -0
  100. package/dist/tools/prompt/enhancePrompt.js.map +1 -0
  101. package/dist/tools/prompt/enhancePromptGemini.d.ts +8 -0
  102. package/dist/tools/prompt/enhancePromptGemini.d.ts.map +1 -0
  103. package/dist/tools/prompt/enhancePromptGemini.js +332 -0
  104. package/dist/tools/prompt/enhancePromptGemini.js.map +1 -0
  105. package/dist/tools/prompt/index.d.ts +7 -0
  106. package/dist/tools/prompt/index.d.ts.map +1 -0
  107. package/dist/tools/prompt/index.js +7 -0
  108. package/dist/tools/prompt/index.js.map +1 -0
  109. package/dist/tools/reasoning/applyReasoningFramework.d.ts +8 -0
  110. package/dist/tools/reasoning/applyReasoningFramework.d.ts.map +1 -0
  111. package/dist/tools/reasoning/applyReasoningFramework.js +266 -0
  112. package/dist/tools/reasoning/applyReasoningFramework.js.map +1 -0
  113. package/dist/tools/reasoning/index.d.ts +5 -0
  114. package/dist/tools/reasoning/index.d.ts.map +1 -0
  115. package/dist/tools/reasoning/index.js +5 -0
  116. package/dist/tools/reasoning/index.js.map +1 -0
  117. package/dist/tools/thinking/analyzeProblem.d.ts +7 -0
  118. package/dist/tools/thinking/analyzeProblem.d.ts.map +1 -0
  119. package/dist/tools/thinking/analyzeProblem.js +55 -0
  120. package/dist/tools/thinking/analyzeProblem.js.map +1 -0
  121. package/dist/tools/thinking/breakDownProblem.d.ts +8 -0
  122. package/dist/tools/thinking/breakDownProblem.d.ts.map +1 -0
  123. package/dist/tools/thinking/breakDownProblem.js +145 -0
  124. package/dist/tools/thinking/breakDownProblem.js.map +1 -0
  125. package/dist/tools/thinking/createThinkingChain.d.ts +7 -0
  126. package/dist/tools/thinking/createThinkingChain.d.ts.map +1 -0
  127. package/dist/tools/thinking/createThinkingChain.js +44 -0
  128. package/dist/tools/thinking/createThinkingChain.js.map +1 -0
  129. package/dist/tools/thinking/formatAsPlan.d.ts +9 -0
  130. package/dist/tools/thinking/formatAsPlan.d.ts.map +1 -0
  131. package/dist/tools/thinking/formatAsPlan.js +78 -0
  132. package/dist/tools/thinking/formatAsPlan.js.map +1 -0
  133. package/dist/tools/thinking/index.d.ts +10 -0
  134. package/dist/tools/thinking/index.d.ts.map +1 -0
  135. package/dist/tools/thinking/index.js +10 -0
  136. package/dist/tools/thinking/index.js.map +1 -0
  137. package/dist/tools/thinking/stepByStepAnalysis.d.ts +8 -0
  138. package/dist/tools/thinking/stepByStepAnalysis.d.ts.map +1 -0
  139. package/dist/tools/thinking/stepByStepAnalysis.js +63 -0
  140. package/dist/tools/thinking/stepByStepAnalysis.js.map +1 -0
  141. package/dist/tools/thinking/thinkAloudProcess.d.ts +8 -0
  142. package/dist/tools/thinking/thinkAloudProcess.d.ts.map +1 -0
  143. package/dist/tools/thinking/thinkAloudProcess.js +80 -0
  144. package/dist/tools/thinking/thinkAloudProcess.js.map +1 -0
  145. package/hooks/hooks.json +204 -195
  146. package/hooks/scripts/code-check.js +22 -22
  147. package/hooks/scripts/code-review.js +22 -22
  148. package/hooks/scripts/complexity.js +22 -22
  149. package/hooks/scripts/compound.js +23 -23
  150. package/hooks/scripts/context-save.js +33 -33
  151. package/hooks/scripts/llm-orchestrate.js +171 -171
  152. package/hooks/scripts/post-edit.js +97 -0
  153. package/hooks/scripts/recall.js +22 -22
  154. package/hooks/scripts/session-start.js +30 -30
  155. package/hooks/scripts/utils.js +97 -65
  156. package/languages/csharp-unity.md +515 -515
  157. package/languages/gdscript-godot.md +470 -470
  158. package/languages/ruby-rails.md +489 -489
  159. package/languages/typescript-angular.md +433 -433
  160. package/languages/typescript-astro.md +416 -416
  161. package/languages/typescript-electron.md +406 -406
  162. package/languages/typescript-nestjs.md +524 -524
  163. package/languages/typescript-svelte.md +407 -407
  164. package/languages/typescript-tauri.md +365 -365
  165. package/package.json +83 -83
  166. package/skills/context7-usage.md +102 -102
  167. package/skills/git-worktree.md +181 -181
  168. package/skills/parallel-research.md +77 -77
  169. package/skills/priority-todos.md +239 -239
  170. package/skills/tool-fallback.md +190 -190
  171. package/skills/vibe-capabilities.md +161 -161
  172. package/vibe/constitution.md +227 -227
  173. package/vibe/rules/core/communication-guide.md +98 -98
  174. package/vibe/rules/core/development-philosophy.md +52 -52
  175. package/vibe/rules/core/quick-start.md +102 -102
  176. package/vibe/rules/quality/bdd-contract-testing.md +393 -393
  177. package/vibe/rules/quality/checklist.md +276 -276
  178. package/vibe/rules/quality/testing-strategy.md +440 -440
  179. package/vibe/rules/standards/anti-patterns.md +541 -369
  180. package/vibe/rules/standards/code-structure.md +291 -291
  181. package/vibe/rules/standards/complexity-metrics.md +313 -313
  182. package/vibe/rules/standards/naming-conventions.md +198 -198
  183. package/vibe/setup.sh +31 -31
  184. package/vibe/templates/constitution-template.md +252 -252
  185. package/vibe/templates/contract-backend-template.md +526 -526
  186. package/vibe/templates/contract-frontend-template.md +599 -599
  187. package/vibe/templates/feature-template.md +96 -96
  188. package/vibe/templates/spec-template.md +221 -221
@@ -1,96 +1,96 @@
1
- # Feature: {Feature Name}
2
-
3
- > This file is **the core of quality assurance**. All scenarios passing = feature complete.
4
-
5
- **SPEC**: `.claude/vibe/specs/{feature-name}.md`
6
- **Last verified**: -
7
- **Quality score**: -
8
-
9
- ---
10
-
11
- ## User Story
12
-
13
- **As a** {User role}
14
- **I want** {Desired functionality}
15
- **So that** {Reason/Value}
16
-
17
- ---
18
-
19
- ## Scenarios
20
-
21
- > Each scenario is both an implementation unit and a verification unit.
22
-
23
- ### Scenario 1: {Happy Path - Normal Case}
24
-
25
- ```gherkin
26
- Scenario: {Scenario title}
27
- Given {Precondition}
28
- # Verification: {What to check}
29
- When {User action}
30
- # Verification: {What functionality is executed}
31
- Then {Expected result}
32
- # Verification: {What is visible or returned}
33
- ```
34
-
35
- **SPEC AC**: #1
36
- **Status**: ⬜
37
-
38
- ---
39
-
40
- ### Scenario 2: {Edge Case - Error Case}
41
-
42
- ```gherkin
43
- Scenario: {Error scenario title}
44
- Given {Precondition}
45
- When {Invalid input or exception}
46
- Then {Error message or appropriate handling}
47
- ```
48
-
49
- **SPEC AC**: #2
50
- **Status**: ⬜
51
-
52
- ---
53
-
54
- ### Scenario 3: {Boundary Case}
55
-
56
- ```gherkin
57
- Scenario: {Boundary value test}
58
- Given {Precondition}
59
- When {Boundary value input}
60
- Then {Appropriate handling}
61
- ```
62
-
63
- **SPEC AC**: #3
64
- **Status**: ⬜
65
-
66
- ---
67
-
68
- ## Coverage Summary
69
-
70
- | # | Scenario | SPEC AC | Status | Retries |
71
- |---|----------|---------|--------|---------|
72
- | 1 | {Happy Path} | AC-1 | ⬜ | - |
73
- | 2 | {Edge Case} | AC-2 | ⬜ | - |
74
- | 3 | {Boundary Case} | AC-3 | ⬜ | - |
75
-
76
- **Total**: 0/3 passed (0%)
77
-
78
- ---
79
-
80
- ## Verification Commands
81
-
82
- ```bash
83
- # Full verification
84
- /vibe.verify "{feature name}"
85
-
86
- # Auto-fix on failure
87
- /vibe.run "{feature name}" --fix
88
- ```
89
-
90
- ---
91
-
92
- ## Notes
93
-
94
- - Update Coverage Summary when adding/modifying scenarios
95
- - Specify verification points for each Given/When/Then
96
- - Quality is assured when all scenarios pass
1
+ # Feature: {Feature Name}
2
+
3
+ > This file is **the core of quality assurance**. All scenarios passing = feature complete.
4
+
5
+ **SPEC**: `.claude/vibe/specs/{feature-name}.md`
6
+ **Last verified**: -
7
+ **Quality score**: -
8
+
9
+ ---
10
+
11
+ ## User Story
12
+
13
+ **As a** {User role}
14
+ **I want** {Desired functionality}
15
+ **So that** {Reason/Value}
16
+
17
+ ---
18
+
19
+ ## Scenarios
20
+
21
+ > Each scenario is both an implementation unit and a verification unit.
22
+
23
+ ### Scenario 1: {Happy Path - Normal Case}
24
+
25
+ ```gherkin
26
+ Scenario: {Scenario title}
27
+ Given {Precondition}
28
+ # Verification: {What to check}
29
+ When {User action}
30
+ # Verification: {What functionality is executed}
31
+ Then {Expected result}
32
+ # Verification: {What is visible or returned}
33
+ ```
34
+
35
+ **SPEC AC**: #1
36
+ **Status**: ⬜
37
+
38
+ ---
39
+
40
+ ### Scenario 2: {Edge Case - Error Case}
41
+
42
+ ```gherkin
43
+ Scenario: {Error scenario title}
44
+ Given {Precondition}
45
+ When {Invalid input or exception}
46
+ Then {Error message or appropriate handling}
47
+ ```
48
+
49
+ **SPEC AC**: #2
50
+ **Status**: ⬜
51
+
52
+ ---
53
+
54
+ ### Scenario 3: {Boundary Case}
55
+
56
+ ```gherkin
57
+ Scenario: {Boundary value test}
58
+ Given {Precondition}
59
+ When {Boundary value input}
60
+ Then {Appropriate handling}
61
+ ```
62
+
63
+ **SPEC AC**: #3
64
+ **Status**: ⬜
65
+
66
+ ---
67
+
68
+ ## Coverage Summary
69
+
70
+ | # | Scenario | SPEC AC | Status | Retries |
71
+ |---|----------|---------|--------|---------|
72
+ | 1 | {Happy Path} | AC-1 | ⬜ | - |
73
+ | 2 | {Edge Case} | AC-2 | ⬜ | - |
74
+ | 3 | {Boundary Case} | AC-3 | ⬜ | - |
75
+
76
+ **Total**: 0/3 passed (0%)
77
+
78
+ ---
79
+
80
+ ## Verification Commands
81
+
82
+ ```bash
83
+ # Full verification
84
+ /vibe.verify "{feature name}"
85
+
86
+ # Auto-fix on failure
87
+ /vibe.run "{feature name}" --fix
88
+ ```
89
+
90
+ ---
91
+
92
+ ## Notes
93
+
94
+ - Update Coverage Summary when adding/modifying scenarios
95
+ - Specify verification points for each Given/When/Then
96
+ - Quality is assured when all scenarios pass
@@ -1,221 +1,221 @@
1
- # SPEC: {Feature Name}
2
-
3
- ## Metadata
4
-
5
- - **Created**: {YYYY-MM-DD}
6
- - **Author**: {Name}
7
- - **Status**: DRAFT
8
- - **Priority**: {HIGH | MEDIUM | LOW}
9
- - **Language**: {en | ko}
10
- - **Assigned Agent**: {Agent Name}
11
- - **Tech Stack**: {Project Tech Stack Summary}
12
-
13
- ---
14
-
15
- ## 1. Feature Overview
16
-
17
- {1-2 sentence summary}
18
-
19
- ### Background
20
-
21
- {Why is this feature needed}
22
-
23
- ### Goals
24
-
25
- - Goal 1
26
- - Goal 2
27
-
28
- ### Non-Goals
29
-
30
- - What we won't do this time 1
31
- - What we won't do this time 2
32
-
33
- ### Tech Stack Context
34
-
35
- **Existing Technology:**
36
-
37
- - Backend: {FastAPI, Django, Express, etc.}
38
- - Frontend: {React, Flutter, Vue, etc.}
39
- - Database: {PostgreSQL, MySQL, MongoDB, etc.}
40
- - Infrastructure: {GCP, AWS, Azure, etc.}
41
-
42
- **New Technology Required for This Feature:**
43
-
44
- - {New library/service 1} - {Reason}
45
- - {New library/service 2} - {Reason}
46
-
47
- **External API/Service Integration:**
48
-
49
- - {Service name} - {Purpose}
50
-
51
- **Constraints:**
52
-
53
- - Cost limit: {Amount}
54
- - Performance requirements: {Target response time, throughput, etc.}
55
-
56
- ---
57
-
58
- ## 2. User Stories
59
-
60
- ### Story 1: {Story Title}
61
-
62
- **As a** {User role}
63
- **I want** {Desired functionality}
64
- **So that** {Reason/Value}
65
-
66
- #### Acceptance Criteria
67
-
68
- - [ ] {Verifiable condition 1}
69
- - [ ] {Verifiable condition 2}
70
-
71
- ---
72
-
73
- ## 3. Requirements (EARS Format)
74
-
75
- ### REQ-001: {Requirement Title}
76
-
77
- **WHEN** {Specific condition}
78
- **THEN** {System behavior} (SHALL | SHOULD | MAY)
79
-
80
- #### Acceptance Criteria
81
-
82
- - [ ] {Testable criterion 1}
83
- - [ ] {Testable criterion 2}
84
-
85
- #### Example
86
-
87
- ```text
88
- Input: {...}
89
- Output: {...}
90
- ```
91
-
92
- ---
93
-
94
- ## 4. Non-Functional Requirements
95
-
96
- ### Performance
97
-
98
- - Response time: {Target}
99
- - Throughput: {Target}
100
-
101
- ### Security
102
-
103
- - Authentication: {Method}
104
- - Authorization: {Rules}
105
-
106
- ### Scalability
107
-
108
- - Expected growth rate: {Value}
109
-
110
- ---
111
-
112
- ## 5. Data Model (Draft)
113
-
114
- ### Entity: {Name}
115
-
116
- ```json
117
- {
118
- "field1": "type",
119
- "field2": "type"
120
- }
121
- ```
122
-
123
- ---
124
-
125
- ## 6. API Contract (Draft)
126
-
127
- ### Endpoint: {Name}
128
-
129
- ```text
130
- POST /api/v1/resource
131
- Request: {...}
132
- Response: {...}
133
- ```
134
-
135
- ---
136
-
137
- ## 7. Test Strategy
138
-
139
- ### BDD Scenarios (Gherkin)
140
-
141
- **Generate Command**: `vibe feature "{feature name}"`
142
-
143
- ```gherkin
144
- Scenario: {Scenario title}
145
- Given {Precondition}
146
- When {User action}
147
- Then {Expected result}
148
- ```
149
-
150
- **Mapping**:
151
-
152
- - REQ-001 → Scenario 1, 2
153
- - REQ-002 → Scenario 3
154
-
155
- ### Contract Tests (API Schema)
156
-
157
- **Generate Command**: `vibe contract "{feature name}"`
158
-
159
- **Backend Contract**:
160
-
161
- ```json
162
- {
163
- "request": {
164
- "method": "POST",
165
- "path": "/api/v1/{resource}",
166
- "schema": {JSON Schema}
167
- },
168
- "response": {
169
- "status": 201,
170
- "schema": {JSON Schema}
171
- }
172
- }
173
- ```
174
-
175
- **Frontend Contract**:
176
-
177
- - Independent testing with mock server
178
- - Response schema validation (Zod, JSON Schema)
179
-
180
- ### Test Coverage Goals
181
-
182
- - [ ] BDD: Cover all Acceptance Criteria
183
- - [ ] Contract: Cover all API endpoints
184
- - [ ] Unit: 70%+ coverage
185
- - [ ] Integration: Cover critical paths
186
-
187
- ---
188
-
189
- ## 8. Out of Scope
190
-
191
- - ❌ {Excluded item 1}
192
- - ❌ {Excluded item 2}
193
-
194
- ---
195
-
196
- ## 9. Verification Checklist
197
-
198
- ### Requirements
199
-
200
- - [ ] Are all requirements testable?
201
- - [ ] Is SHALL/SHOULD/MAY clear?
202
- - [ ] Are Acceptance Criteria specific?
203
- - [ ] Are performance goals measurable?
204
-
205
- ### Testing
206
-
207
- - [ ] BDD Feature file generation complete?
208
- - [ ] Contract tests defined?
209
- - [ ] Step Definitions written?
210
- - [ ] Test coverage goal achieved?
211
-
212
- ---
213
-
214
- ## 10. Approval
215
-
216
- - [ ] User approval
217
- - [ ] Technical review complete
218
- - [ ] Test plan approved
219
-
220
- Approval Date: ____________
221
- Approver: ____________
1
+ # SPEC: {Feature Name}
2
+
3
+ ## Metadata
4
+
5
+ - **Created**: {YYYY-MM-DD}
6
+ - **Author**: {Name}
7
+ - **Status**: DRAFT
8
+ - **Priority**: {HIGH | MEDIUM | LOW}
9
+ - **Language**: {en | ko}
10
+ - **Assigned Agent**: {Agent Name}
11
+ - **Tech Stack**: {Project Tech Stack Summary}
12
+
13
+ ---
14
+
15
+ ## 1. Feature Overview
16
+
17
+ {1-2 sentence summary}
18
+
19
+ ### Background
20
+
21
+ {Why is this feature needed}
22
+
23
+ ### Goals
24
+
25
+ - Goal 1
26
+ - Goal 2
27
+
28
+ ### Non-Goals
29
+
30
+ - What we won't do this time 1
31
+ - What we won't do this time 2
32
+
33
+ ### Tech Stack Context
34
+
35
+ **Existing Technology:**
36
+
37
+ - Backend: {FastAPI, Django, Express, etc.}
38
+ - Frontend: {React, Flutter, Vue, etc.}
39
+ - Database: {PostgreSQL, MySQL, MongoDB, etc.}
40
+ - Infrastructure: {GCP, AWS, Azure, etc.}
41
+
42
+ **New Technology Required for This Feature:**
43
+
44
+ - {New library/service 1} - {Reason}
45
+ - {New library/service 2} - {Reason}
46
+
47
+ **External API/Service Integration:**
48
+
49
+ - {Service name} - {Purpose}
50
+
51
+ **Constraints:**
52
+
53
+ - Cost limit: {Amount}
54
+ - Performance requirements: {Target response time, throughput, etc.}
55
+
56
+ ---
57
+
58
+ ## 2. User Stories
59
+
60
+ ### Story 1: {Story Title}
61
+
62
+ **As a** {User role}
63
+ **I want** {Desired functionality}
64
+ **So that** {Reason/Value}
65
+
66
+ #### Acceptance Criteria
67
+
68
+ - [ ] {Verifiable condition 1}
69
+ - [ ] {Verifiable condition 2}
70
+
71
+ ---
72
+
73
+ ## 3. Requirements (EARS Format)
74
+
75
+ ### REQ-001: {Requirement Title}
76
+
77
+ **WHEN** {Specific condition}
78
+ **THEN** {System behavior} (SHALL | SHOULD | MAY)
79
+
80
+ #### Acceptance Criteria
81
+
82
+ - [ ] {Testable criterion 1}
83
+ - [ ] {Testable criterion 2}
84
+
85
+ #### Example
86
+
87
+ ```text
88
+ Input: {...}
89
+ Output: {...}
90
+ ```
91
+
92
+ ---
93
+
94
+ ## 4. Non-Functional Requirements
95
+
96
+ ### Performance
97
+
98
+ - Response time: {Target}
99
+ - Throughput: {Target}
100
+
101
+ ### Security
102
+
103
+ - Authentication: {Method}
104
+ - Authorization: {Rules}
105
+
106
+ ### Scalability
107
+
108
+ - Expected growth rate: {Value}
109
+
110
+ ---
111
+
112
+ ## 5. Data Model (Draft)
113
+
114
+ ### Entity: {Name}
115
+
116
+ ```json
117
+ {
118
+ "field1": "type",
119
+ "field2": "type"
120
+ }
121
+ ```
122
+
123
+ ---
124
+
125
+ ## 6. API Contract (Draft)
126
+
127
+ ### Endpoint: {Name}
128
+
129
+ ```text
130
+ POST /api/v1/resource
131
+ Request: {...}
132
+ Response: {...}
133
+ ```
134
+
135
+ ---
136
+
137
+ ## 7. Test Strategy
138
+
139
+ ### BDD Scenarios (Gherkin)
140
+
141
+ **Generate Command**: `vibe feature "{feature name}"`
142
+
143
+ ```gherkin
144
+ Scenario: {Scenario title}
145
+ Given {Precondition}
146
+ When {User action}
147
+ Then {Expected result}
148
+ ```
149
+
150
+ **Mapping**:
151
+
152
+ - REQ-001 → Scenario 1, 2
153
+ - REQ-002 → Scenario 3
154
+
155
+ ### Contract Tests (API Schema)
156
+
157
+ **Generate Command**: `vibe contract "{feature name}"`
158
+
159
+ **Backend Contract**:
160
+
161
+ ```json
162
+ {
163
+ "request": {
164
+ "method": "POST",
165
+ "path": "/api/v1/{resource}",
166
+ "schema": {JSON Schema}
167
+ },
168
+ "response": {
169
+ "status": 201,
170
+ "schema": {JSON Schema}
171
+ }
172
+ }
173
+ ```
174
+
175
+ **Frontend Contract**:
176
+
177
+ - Independent testing with mock server
178
+ - Response schema validation (Zod, JSON Schema)
179
+
180
+ ### Test Coverage Goals
181
+
182
+ - [ ] BDD: Cover all Acceptance Criteria
183
+ - [ ] Contract: Cover all API endpoints
184
+ - [ ] Unit: 70%+ coverage
185
+ - [ ] Integration: Cover critical paths
186
+
187
+ ---
188
+
189
+ ## 8. Out of Scope
190
+
191
+ - ❌ {Excluded item 1}
192
+ - ❌ {Excluded item 2}
193
+
194
+ ---
195
+
196
+ ## 9. Verification Checklist
197
+
198
+ ### Requirements
199
+
200
+ - [ ] Are all requirements testable?
201
+ - [ ] Is SHALL/SHOULD/MAY clear?
202
+ - [ ] Are Acceptance Criteria specific?
203
+ - [ ] Are performance goals measurable?
204
+
205
+ ### Testing
206
+
207
+ - [ ] BDD Feature file generation complete?
208
+ - [ ] Contract tests defined?
209
+ - [ ] Step Definitions written?
210
+ - [ ] Test coverage goal achieved?
211
+
212
+ ---
213
+
214
+ ## 10. Approval
215
+
216
+ - [ ] User approval
217
+ - [ ] Technical review complete
218
+ - [ ] Test plan approved
219
+
220
+ Approval Date: ____________
221
+ Approver: ____________