@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,227 +1,227 @@
1
- # Project Constitution
2
-
3
- This document defines the core principles and coding standards for the project.
4
-
5
- ---
6
-
7
- ## Conversation Language
8
-
9
- **Response Language**: Auto-detected from OS (en/ko)
10
-
11
- This setting controls **conversation language with user only**.
12
- All generated documents (SPEC, Feature, etc.) are **always in English**.
13
-
14
- To change, modify in `.claude/vibe/config.json`:
15
-
16
- ```json
17
- {
18
- "language": "ko" // "en" | "ko" - conversation language only
19
- }
20
- ```
21
-
22
- ---
23
-
24
- ## Document References
25
-
26
- All reference documents are stored globally and specified in `.claude/vibe/config.json`:
27
-
28
- ```json
29
- {
30
- "references": {
31
- "rules": [
32
- "~/.claude/vibe/rules/core/quick-start.md",
33
- "~/.claude/vibe/rules/core/development-philosophy.md",
34
- "~/.claude/vibe/rules/core/communication-guide.md",
35
- "~/.claude/vibe/rules/quality/checklist.md",
36
- "~/.claude/vibe/rules/quality/bdd-contract-testing.md",
37
- "~/.claude/vibe/rules/quality/testing-strategy.md",
38
- "~/.claude/vibe/rules/standards/anti-patterns.md",
39
- "~/.claude/vibe/rules/standards/code-structure.md",
40
- "~/.claude/vibe/rules/standards/complexity-metrics.md",
41
- "~/.claude/vibe/rules/standards/naming-conventions.md"
42
- ],
43
- "languages": [
44
- "~/.claude/vibe/languages/{detected-stack}.md"
45
- ],
46
- "templates": [
47
- "~/.claude/vibe/templates/spec-template.md",
48
- "~/.claude/vibe/templates/feature-template.md",
49
- "~/.claude/vibe/templates/constitution-template.md",
50
- "~/.claude/vibe/templates/contract-backend-template.md",
51
- "~/.claude/vibe/templates/contract-frontend-template.md"
52
- ]
53
- }
54
- }
55
- ```
56
-
57
- - **rules**: Core principles, quality standards, coding conventions (10 documents)
58
- - **languages**: Stack-specific coding standards (auto-detected from package.json)
59
- - **templates**: Document templates for SPEC, Feature, Contract tests (5 documents)
60
-
61
- ---
62
-
63
- ## 1. Project Principles
64
-
65
- ### Values
66
- 1. **User-Centric**: User experience first
67
- 2. **Quality**: Correct over fast
68
- 3. **Simplicity**: Simple over complex
69
- 4. **Collaboration**: Team over individual
70
-
71
- ### Decision Criteria
72
- 1. Security > Performance > Convenience
73
- 2. Clarity > Cleverness
74
- 3. Testable > Abstract Design
75
-
76
- ---
77
-
78
- ## 2. Coding Standards
79
-
80
- ### Common Principles
81
- - **DRY**: Don't Repeat Yourself
82
- - **SRP**: Single Responsibility Principle
83
- - **YAGNI**: You Aren't Gonna Need It
84
- - **Functions ≤30 lines** (recommended), ≤50 lines (allowed)
85
- - **Cyclomatic Complexity ≤10**
86
- - **Cognitive Complexity ≤15**
87
-
88
- ### Naming Rules
89
- - Variables: nouns (`userData`, `userList`)
90
- - Functions: verb+noun (`fetchData`, `updateUser`)
91
- - Boolean: `is/has/can` (`isLoading`, `hasError`)
92
- - Constants: `UPPER_SNAKE_CASE` (`MAX_RETRY_COUNT`)
93
-
94
- ---
95
-
96
- ## 3. Quality Standards (TRUST 5)
97
-
98
- ### T - Test-first
99
- - ✅ Contract Testing (highest priority)
100
- - ✅ Integration Testing (70%+ coverage)
101
- - 🔵 Unit Testing (pure functions only)
102
-
103
- ### R - Readable
104
- - Clear comments and docstrings
105
- - Descriptive variable names
106
- - Comments for complex logic
107
-
108
- ### U - Unified
109
- - Consistent coding style
110
- - Same patterns across project
111
-
112
- ### S - Secured
113
- - SQL Injection prevention
114
- - XSS prevention
115
- - Sensitive info via environment variables
116
-
117
- ### T - Trackable
118
- - Clear git commit messages
119
- - Use TODO/FIXME comments
120
- - Document important decisions
121
-
122
- ---
123
-
124
- ## 4. Tech Stack
125
-
126
- ### Backend
127
- - Language: TypeScript/Node.js
128
- - Framework: Express/Fastify
129
- - Database: SQLite
130
-
131
- ### Frontend
132
- - Framework: {Flutter / React / etc.}
133
- - State Management: (configure per project)
134
-
135
- ### Infrastructure
136
- - Hosting: (configure per project)
137
- - CI/CD: (configure per project)
138
-
139
- ---
140
-
141
- ## 5. Git Workflow
142
-
143
- ### Branch Strategy
144
- - `main`: Production
145
- - `develop`: Development (default branch)
146
- - `feature/{feature-name}`: New features
147
- - `fix/{bug-name}`: Bug fixes
148
-
149
- ### Commit Message Rules
150
- ```
151
- feat: Add new feature
152
- fix: Fix bug
153
- docs: Update documentation
154
- refactor: Refactoring
155
- test: Add/modify tests
156
- chore: Build, config changes
157
- ```
158
-
159
- ### PR Rules
160
- 1. SPEC-based development
161
- 2. Code review required
162
- 3. Tests must pass
163
- 4. SPEC verification complete
164
-
165
- ---
166
-
167
- ## 6. Code Review Criteria
168
-
169
- ### Required Checks
170
- - [ ] SPEC requirements met
171
- - [ ] TRUST 5 compliant
172
- - [ ] Tests written and passing
173
- - [ ] Documentation complete
174
- - [ ] No security issues
175
-
176
- ### Recommendations
177
- - [ ] Performance optimization considered
178
- - [ ] Scalability considered
179
- - [ ] Error handling complete
180
-
181
- ---
182
-
183
- ## 7. Documentation Rules
184
-
185
- ### Code Comments
186
- - All functions: docstrings
187
- - Complex logic: inline comments
188
- - TODO/FIXME: include issue number
189
-
190
- ### API Documentation
191
- - OpenAPI (Swagger) auto-generated
192
- - Include example Request/Response
193
-
194
- ### README
195
- - Project overview
196
- - Installation and run instructions
197
- - Main features description
198
-
199
- ---
200
-
201
- ## 8. Security Policy
202
-
203
- ### Authentication
204
- - JWT-based authentication
205
- - Refresh token usage
206
-
207
- ### Authorization
208
- - Role-based Access Control
209
- - Least privilege principle
210
-
211
- ### Data Protection
212
- - Encrypt personal information
213
- - HTTPS required
214
- - Manage secrets via environment variables
215
-
216
- ---
217
-
218
- ## 9. Performance Goals
219
-
220
- ### Response Time
221
- - API: P95 < 500ms
222
- - Web page: FCP < 1.5s
223
-
224
- ### Availability
225
- - Uptime: 99.9%
226
- - RTO: 1 hour
227
- - RPO: 15 minutes
1
+ # Project Constitution
2
+
3
+ This document defines the core principles and coding standards for the project.
4
+
5
+ ---
6
+
7
+ ## Conversation Language
8
+
9
+ **Response Language**: Auto-detected from OS (en/ko)
10
+
11
+ This setting controls **conversation language with user only**.
12
+ All generated documents (SPEC, Feature, etc.) are **always in English**.
13
+
14
+ To change, modify in `.claude/vibe/config.json`:
15
+
16
+ ```json
17
+ {
18
+ "language": "ko" // "en" | "ko" - conversation language only
19
+ }
20
+ ```
21
+
22
+ ---
23
+
24
+ ## Document References
25
+
26
+ All reference documents are stored globally and specified in `.claude/vibe/config.json`:
27
+
28
+ ```json
29
+ {
30
+ "references": {
31
+ "rules": [
32
+ "~/.claude/vibe/rules/core/quick-start.md",
33
+ "~/.claude/vibe/rules/core/development-philosophy.md",
34
+ "~/.claude/vibe/rules/core/communication-guide.md",
35
+ "~/.claude/vibe/rules/quality/checklist.md",
36
+ "~/.claude/vibe/rules/quality/bdd-contract-testing.md",
37
+ "~/.claude/vibe/rules/quality/testing-strategy.md",
38
+ "~/.claude/vibe/rules/standards/anti-patterns.md",
39
+ "~/.claude/vibe/rules/standards/code-structure.md",
40
+ "~/.claude/vibe/rules/standards/complexity-metrics.md",
41
+ "~/.claude/vibe/rules/standards/naming-conventions.md"
42
+ ],
43
+ "languages": [
44
+ "~/.claude/vibe/languages/{detected-stack}.md"
45
+ ],
46
+ "templates": [
47
+ "~/.claude/vibe/templates/spec-template.md",
48
+ "~/.claude/vibe/templates/feature-template.md",
49
+ "~/.claude/vibe/templates/constitution-template.md",
50
+ "~/.claude/vibe/templates/contract-backend-template.md",
51
+ "~/.claude/vibe/templates/contract-frontend-template.md"
52
+ ]
53
+ }
54
+ }
55
+ ```
56
+
57
+ - **rules**: Core principles, quality standards, coding conventions (10 documents)
58
+ - **languages**: Stack-specific coding standards (auto-detected from package.json)
59
+ - **templates**: Document templates for SPEC, Feature, Contract tests (5 documents)
60
+
61
+ ---
62
+
63
+ ## 1. Project Principles
64
+
65
+ ### Values
66
+ 1. **User-Centric**: User experience first
67
+ 2. **Quality**: Correct over fast
68
+ 3. **Simplicity**: Simple over complex
69
+ 4. **Collaboration**: Team over individual
70
+
71
+ ### Decision Criteria
72
+ 1. Security > Performance > Convenience
73
+ 2. Clarity > Cleverness
74
+ 3. Testable > Abstract Design
75
+
76
+ ---
77
+
78
+ ## 2. Coding Standards
79
+
80
+ ### Common Principles
81
+ - **DRY**: Don't Repeat Yourself
82
+ - **SRP**: Single Responsibility Principle
83
+ - **YAGNI**: You Aren't Gonna Need It
84
+ - **Functions ≤30 lines** (recommended), ≤50 lines (allowed)
85
+ - **Cyclomatic Complexity ≤10**
86
+ - **Cognitive Complexity ≤15**
87
+
88
+ ### Naming Rules
89
+ - Variables: nouns (`userData`, `userList`)
90
+ - Functions: verb+noun (`fetchData`, `updateUser`)
91
+ - Boolean: `is/has/can` (`isLoading`, `hasError`)
92
+ - Constants: `UPPER_SNAKE_CASE` (`MAX_RETRY_COUNT`)
93
+
94
+ ---
95
+
96
+ ## 3. Quality Standards (TRUST 5)
97
+
98
+ ### T - Test-first
99
+ - ✅ Contract Testing (highest priority)
100
+ - ✅ Integration Testing (70%+ coverage)
101
+ - 🔵 Unit Testing (pure functions only)
102
+
103
+ ### R - Readable
104
+ - Clear comments and docstrings
105
+ - Descriptive variable names
106
+ - Comments for complex logic
107
+
108
+ ### U - Unified
109
+ - Consistent coding style
110
+ - Same patterns across project
111
+
112
+ ### S - Secured
113
+ - SQL Injection prevention
114
+ - XSS prevention
115
+ - Sensitive info via environment variables
116
+
117
+ ### T - Trackable
118
+ - Clear git commit messages
119
+ - Use TODO/FIXME comments
120
+ - Document important decisions
121
+
122
+ ---
123
+
124
+ ## 4. Tech Stack
125
+
126
+ ### Backend
127
+ - Language: TypeScript/Node.js
128
+ - Framework: Express/Fastify
129
+ - Database: SQLite
130
+
131
+ ### Frontend
132
+ - Framework: {Flutter / React / etc.}
133
+ - State Management: (configure per project)
134
+
135
+ ### Infrastructure
136
+ - Hosting: (configure per project)
137
+ - CI/CD: (configure per project)
138
+
139
+ ---
140
+
141
+ ## 5. Git Workflow
142
+
143
+ ### Branch Strategy
144
+ - `main`: Production
145
+ - `develop`: Development (default branch)
146
+ - `feature/{feature-name}`: New features
147
+ - `fix/{bug-name}`: Bug fixes
148
+
149
+ ### Commit Message Rules
150
+ ```
151
+ feat: Add new feature
152
+ fix: Fix bug
153
+ docs: Update documentation
154
+ refactor: Refactoring
155
+ test: Add/modify tests
156
+ chore: Build, config changes
157
+ ```
158
+
159
+ ### PR Rules
160
+ 1. SPEC-based development
161
+ 2. Code review required
162
+ 3. Tests must pass
163
+ 4. SPEC verification complete
164
+
165
+ ---
166
+
167
+ ## 6. Code Review Criteria
168
+
169
+ ### Required Checks
170
+ - [ ] SPEC requirements met
171
+ - [ ] TRUST 5 compliant
172
+ - [ ] Tests written and passing
173
+ - [ ] Documentation complete
174
+ - [ ] No security issues
175
+
176
+ ### Recommendations
177
+ - [ ] Performance optimization considered
178
+ - [ ] Scalability considered
179
+ - [ ] Error handling complete
180
+
181
+ ---
182
+
183
+ ## 7. Documentation Rules
184
+
185
+ ### Code Comments
186
+ - All functions: docstrings
187
+ - Complex logic: inline comments
188
+ - TODO/FIXME: include issue number
189
+
190
+ ### API Documentation
191
+ - OpenAPI (Swagger) auto-generated
192
+ - Include example Request/Response
193
+
194
+ ### README
195
+ - Project overview
196
+ - Installation and run instructions
197
+ - Main features description
198
+
199
+ ---
200
+
201
+ ## 8. Security Policy
202
+
203
+ ### Authentication
204
+ - JWT-based authentication
205
+ - Refresh token usage
206
+
207
+ ### Authorization
208
+ - Role-based Access Control
209
+ - Least privilege principle
210
+
211
+ ### Data Protection
212
+ - Encrypt personal information
213
+ - HTTPS required
214
+ - Manage secrets via environment variables
215
+
216
+ ---
217
+
218
+ ## 9. Performance Goals
219
+
220
+ ### Response Time
221
+ - API: P95 < 500ms
222
+ - Web page: FCP < 1.5s
223
+
224
+ ### Availability
225
+ - Uptime: 99.9%
226
+ - RTO: 1 hour
227
+ - RPO: 15 minutes
@@ -1,98 +1,98 @@
1
- # Communication Guide
2
-
3
- ## Language Configuration
4
-
5
- Language can be configured per project in `.sutory/config.json`. Code itself (function names, variable names, etc.) should always be in English.
6
-
7
- ## 3.1 Code Delivery Format
8
-
9
- ```markdown
10
- ### Scope of Work
11
-
12
- "As requested, I only modified the state management logic in the UserProfile component."
13
-
14
- ### Summary of Changes
15
-
16
- Improved order status update logic - Applied optimistic updates
17
-
18
- ### Code
19
-
20
- [Complete code block]
21
-
22
- ### Notes
23
-
24
- - Auto-rollback on error
25
- - 3 network retries
26
- ```
27
-
28
- ## 3.2 Review Response Format
29
-
30
- ```markdown
31
- ### Improvements
32
-
33
- 1. Missing memoization (performance)
34
- 2. Error boundary not applied (stability)
35
-
36
- ### Recommendations
37
-
38
- Apply useMemo and wrap with ErrorBoundary
39
- ```
40
-
41
- ## 3.3 Error Report Format
42
-
43
- ```markdown
44
- ### Problem
45
-
46
- [Clearly explain the issue that occurred]
47
-
48
- ### Cause
49
-
50
- [Analyzed cause]
51
-
52
- ### Solution
53
-
54
- [Specific resolution steps]
55
-
56
- ### Prevention
57
-
58
- [How to prevent in the future]
59
- ```
60
-
61
- ## 3.4 Change Explanation Principles
62
-
63
- - **Clarity**: Clearly explain what was changed and why
64
- - **Conciseness**: Communicate only the essentials
65
- - **Completeness**: Include side effects and caveats
66
- - **Traceability**: Reference related issues/requests
67
-
68
- ## 3.5 Special Command Execution
69
-
70
- - **"optimize"**: Performance improvements (memoization, bundle size, etc.)
71
- - **"enhance accessibility"**: Add ARIA, keyboard support, etc.
72
- - **"strengthen types"**: Remove `any`, improve type safety
73
- - **"cleanup"**: Remove unnecessary code (only when requested)
74
- - **"split"**: Separate components/functions (only when requested)
75
-
76
- ## 3.6 Question Format
77
-
78
- ### When Clarity is Needed
79
-
80
- ```markdown
81
- Please clarify the following:
82
-
83
- 1. [Specific question 1]
84
- 2. [Specific question 2]
85
-
86
- With this information, a more accurate implementation is possible.
87
- ```
88
-
89
- ### Presenting Alternatives
90
-
91
- ```markdown
92
- In addition to your requested approach, the following alternatives are possible:
93
-
94
- **Method A**: [Description] - Pros: [Pros], Cons: [Cons]
95
- **Method B**: [Description] - Pros: [Pros], Cons: [Cons]
96
-
97
- Which approach do you prefer?
98
- ```
1
+ # Communication Guide
2
+
3
+ ## Language Configuration
4
+
5
+ Language can be configured per project in `.sutory/config.json`. Code itself (function names, variable names, etc.) should always be in English.
6
+
7
+ ## 3.1 Code Delivery Format
8
+
9
+ ```markdown
10
+ ### Scope of Work
11
+
12
+ "As requested, I only modified the state management logic in the UserProfile component."
13
+
14
+ ### Summary of Changes
15
+
16
+ Improved order status update logic - Applied optimistic updates
17
+
18
+ ### Code
19
+
20
+ [Complete code block]
21
+
22
+ ### Notes
23
+
24
+ - Auto-rollback on error
25
+ - 3 network retries
26
+ ```
27
+
28
+ ## 3.2 Review Response Format
29
+
30
+ ```markdown
31
+ ### Improvements
32
+
33
+ 1. Missing memoization (performance)
34
+ 2. Error boundary not applied (stability)
35
+
36
+ ### Recommendations
37
+
38
+ Apply useMemo and wrap with ErrorBoundary
39
+ ```
40
+
41
+ ## 3.3 Error Report Format
42
+
43
+ ```markdown
44
+ ### Problem
45
+
46
+ [Clearly explain the issue that occurred]
47
+
48
+ ### Cause
49
+
50
+ [Analyzed cause]
51
+
52
+ ### Solution
53
+
54
+ [Specific resolution steps]
55
+
56
+ ### Prevention
57
+
58
+ [How to prevent in the future]
59
+ ```
60
+
61
+ ## 3.4 Change Explanation Principles
62
+
63
+ - **Clarity**: Clearly explain what was changed and why
64
+ - **Conciseness**: Communicate only the essentials
65
+ - **Completeness**: Include side effects and caveats
66
+ - **Traceability**: Reference related issues/requests
67
+
68
+ ## 3.5 Special Command Execution
69
+
70
+ - **"optimize"**: Performance improvements (memoization, bundle size, etc.)
71
+ - **"enhance accessibility"**: Add ARIA, keyboard support, etc.
72
+ - **"strengthen types"**: Remove `any`, improve type safety
73
+ - **"cleanup"**: Remove unnecessary code (only when requested)
74
+ - **"split"**: Separate components/functions (only when requested)
75
+
76
+ ## 3.6 Question Format
77
+
78
+ ### When Clarity is Needed
79
+
80
+ ```markdown
81
+ Please clarify the following:
82
+
83
+ 1. [Specific question 1]
84
+ 2. [Specific question 2]
85
+
86
+ With this information, a more accurate implementation is possible.
87
+ ```
88
+
89
+ ### Presenting Alternatives
90
+
91
+ ```markdown
92
+ In addition to your requested approach, the following alternatives are possible:
93
+
94
+ **Method A**: [Description] - Pros: [Pros], Cons: [Cons]
95
+ **Method B**: [Description] - Pros: [Pros], Cons: [Cons]
96
+
97
+ Which approach do you prefer?
98
+ ```