@su-record/vibe 2.9.18 → 2.9.20

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 (459) hide show
  1. package/.env.example +37 -37
  2. package/CLAUDE.md +6 -2
  3. package/LICENSE +21 -21
  4. package/agents/architect-low.md +41 -41
  5. package/agents/architect-medium.md +59 -59
  6. package/agents/architect.md +80 -80
  7. package/agents/build-error-resolver.md +115 -115
  8. package/agents/compounder.md +261 -261
  9. package/agents/diagrammer.md +178 -178
  10. package/agents/docs/api-documenter.md +99 -99
  11. package/agents/docs/changelog-writer.md +93 -93
  12. package/agents/e2e-tester.md +294 -294
  13. package/agents/event/event-comms.md +78 -78
  14. package/agents/event/event-content.md +68 -68
  15. package/agents/event/event-image.md +95 -95
  16. package/agents/event/event-ops.md +84 -84
  17. package/agents/event/event-scheduler.md +69 -69
  18. package/agents/event/event-speaker.md +86 -86
  19. package/agents/explorer-low.md +42 -42
  20. package/agents/explorer-medium.md +59 -59
  21. package/agents/explorer.md +48 -48
  22. package/agents/implementer-low.md +43 -43
  23. package/agents/implementer-medium.md +52 -52
  24. package/agents/implementer.md +54 -54
  25. package/agents/junior-mentor.md +141 -141
  26. package/agents/planning/requirements-analyst.md +84 -84
  27. package/agents/planning/ux-advisor.md +83 -83
  28. package/agents/qa/acceptance-tester.md +86 -86
  29. package/agents/qa/edge-case-finder.md +93 -93
  30. package/agents/qa/qa-coordinator.md +131 -131
  31. package/agents/refactor-cleaner.md +143 -143
  32. package/agents/research/best-practices-agent.md +199 -199
  33. package/agents/research/codebase-patterns-agent.md +157 -157
  34. package/agents/research/framework-docs-agent.md +188 -188
  35. package/agents/research/security-advisory-agent.md +213 -213
  36. package/agents/review/architecture-reviewer.md +107 -107
  37. package/agents/review/complexity-reviewer.md +116 -116
  38. package/agents/review/data-integrity-reviewer.md +88 -88
  39. package/agents/review/git-history-reviewer.md +103 -103
  40. package/agents/review/performance-reviewer.md +86 -86
  41. package/agents/review/python-reviewer.md +150 -150
  42. package/agents/review/rails-reviewer.md +139 -139
  43. package/agents/review/react-reviewer.md +144 -144
  44. package/agents/review/security-reviewer.md +80 -80
  45. package/agents/review/simplicity-reviewer.md +140 -140
  46. package/agents/review/test-coverage-reviewer.md +116 -116
  47. package/agents/review/typescript-reviewer.md +127 -127
  48. package/agents/searcher.md +54 -54
  49. package/agents/simplifier.md +120 -120
  50. package/agents/teams/debug-team.md +70 -70
  51. package/agents/teams/dev-team.md +88 -88
  52. package/agents/teams/docs-team.md +80 -80
  53. package/agents/teams/figma/figma-analyst.md +52 -52
  54. package/agents/teams/figma/figma-architect.md +112 -112
  55. package/agents/teams/figma/figma-auditor.md +82 -82
  56. package/agents/teams/figma/figma-builder.md +100 -100
  57. package/agents/teams/figma-team.md +85 -85
  58. package/agents/teams/fullstack-team.md +83 -83
  59. package/agents/teams/lite-team.md +69 -69
  60. package/agents/teams/migration-team.md +78 -78
  61. package/agents/teams/refactor-team.md +94 -94
  62. package/agents/teams/research-team.md +86 -86
  63. package/agents/teams/review-debate-team.md +125 -125
  64. package/agents/teams/security-team.md +81 -81
  65. package/agents/tester.md +49 -49
  66. package/agents/ui/ui-a11y-auditor.md +93 -93
  67. package/agents/ui/ui-antipattern-detector.md +102 -102
  68. package/agents/ui/ui-dataviz-advisor.md +69 -69
  69. package/agents/ui/ui-design-system-gen.md +57 -57
  70. package/agents/ui/ui-industry-analyzer.md +49 -49
  71. package/agents/ui/ui-layout-architect.md +65 -65
  72. package/agents/ui/ui-stack-implementer.md +68 -68
  73. package/agents/ui/ux-compliance-reviewer.md +81 -81
  74. package/agents/ui-previewer.md +258 -258
  75. package/commands/vibe.analyze.md +533 -533
  76. package/commands/vibe.contract.md +105 -0
  77. package/commands/vibe.docs.md +33 -33
  78. package/commands/vibe.event.md +163 -163
  79. package/commands/vibe.figma.md +584 -584
  80. package/commands/vibe.harness.md +177 -177
  81. package/commands/vibe.regress.md +73 -0
  82. package/commands/vibe.review.md +624 -624
  83. package/commands/vibe.run.md +1940 -1925
  84. package/commands/vibe.scaffold.md +195 -195
  85. package/commands/vibe.spec.md +577 -565
  86. package/commands/vibe.trace.md +276 -276
  87. package/commands/vibe.utils.md +413 -413
  88. package/commands/vibe.verify.md +550 -519
  89. package/dist/cli/collaborator.js +52 -52
  90. package/dist/cli/commands/codex-proxy.js +15 -15
  91. package/dist/cli/commands/config.js +9 -9
  92. package/dist/cli/commands/evolution.js +12 -12
  93. package/dist/cli/commands/figma.js +20 -20
  94. package/dist/cli/commands/info.js +52 -52
  95. package/dist/cli/commands/init.js +5 -5
  96. package/dist/cli/commands/remove.js +14 -14
  97. package/dist/cli/commands/sentinel.js +27 -27
  98. package/dist/cli/commands/skills.js +5 -5
  99. package/dist/cli/commands/slack.js +10 -10
  100. package/dist/cli/commands/stats.js +6 -6
  101. package/dist/cli/commands/telegram.js +12 -12
  102. package/dist/cli/detect.js +32 -32
  103. package/dist/cli/index.js +33 -33
  104. package/dist/cli/llm/claude-commands.js +16 -16
  105. package/dist/cli/llm/config.js +18 -18
  106. package/dist/cli/llm/gemini-commands.js +16 -16
  107. package/dist/cli/llm/gpt-commands.js +19 -19
  108. package/dist/cli/llm/help.js +21 -21
  109. package/dist/cli/postinstall/cursor-agents.js +32 -32
  110. package/dist/cli/postinstall/cursor-rules.js +83 -83
  111. package/dist/cli/postinstall/cursor-skills.js +743 -743
  112. package/dist/cli/setup/GlobalInstaller.d.ts.map +1 -1
  113. package/dist/cli/setup/GlobalInstaller.js +9 -0
  114. package/dist/cli/setup/GlobalInstaller.js.map +1 -1
  115. package/dist/cli/setup/Provisioner.js +42 -42
  116. package/dist/infra/lib/DeepInit.js +24 -24
  117. package/dist/infra/lib/IterationTracker.js +11 -11
  118. package/dist/infra/lib/PythonParser.js +108 -108
  119. package/dist/infra/lib/ReviewRace.js +96 -96
  120. package/dist/infra/lib/SkillFrontmatter.js +28 -28
  121. package/dist/infra/lib/SkillQualityGate.js +9 -9
  122. package/dist/infra/lib/SkillRepository.js +159 -159
  123. package/dist/infra/lib/UltraQA.js +99 -99
  124. package/dist/infra/lib/autonomy/AuditStore.js +41 -41
  125. package/dist/infra/lib/autonomy/ConfirmationStore.js +30 -30
  126. package/dist/infra/lib/autonomy/EventOutbox.js +38 -38
  127. package/dist/infra/lib/autonomy/PolicyEngine.d.ts +3 -3
  128. package/dist/infra/lib/autonomy/PolicyEngine.js +18 -18
  129. package/dist/infra/lib/autonomy/SecuritySentinel.js +1 -1
  130. package/dist/infra/lib/autonomy/SuggestionStore.js +33 -33
  131. package/dist/infra/lib/embedding/VectorStore.js +22 -22
  132. package/dist/infra/lib/evolution/AgentAnalyzer.js +10 -10
  133. package/dist/infra/lib/evolution/DescriptionOptimizer.js +21 -21
  134. package/dist/infra/lib/evolution/GenerationRegistry.js +36 -36
  135. package/dist/infra/lib/evolution/InsightStore.js +90 -90
  136. package/dist/infra/lib/evolution/ParityTester.js +57 -57
  137. package/dist/infra/lib/evolution/RollbackManager.js +5 -5
  138. package/dist/infra/lib/evolution/SkillBenchmark.js +23 -23
  139. package/dist/infra/lib/evolution/SkillEvalRunner.js +50 -50
  140. package/dist/infra/lib/evolution/SkillGapDetector.js +10 -10
  141. package/dist/infra/lib/evolution/UsageTracker.js +28 -28
  142. package/dist/infra/lib/gemini/orchestration.js +5 -5
  143. package/dist/infra/lib/gpt/orchestration.js +4 -4
  144. package/dist/infra/lib/memory/KnowledgeGraph.js +4 -4
  145. package/dist/infra/lib/memory/MemorySearch.js +57 -57
  146. package/dist/infra/lib/memory/MemoryStorage.js +181 -181
  147. package/dist/infra/lib/memory/ObservationStore.js +28 -28
  148. package/dist/infra/lib/memory/ReflectionStore.js +30 -30
  149. package/dist/infra/lib/memory/SessionRAGRetriever.js +7 -7
  150. package/dist/infra/lib/memory/SessionRAGStore.js +225 -225
  151. package/dist/infra/lib/memory/SessionSummarizer.js +9 -9
  152. package/dist/infra/orchestrator/AgentManager.js +12 -12
  153. package/dist/infra/orchestrator/AgentRegistry.js +65 -65
  154. package/dist/infra/orchestrator/MultiLlmResearch.js +8 -8
  155. package/dist/infra/orchestrator/SwarmOrchestrator.test.js +16 -16
  156. package/dist/infra/orchestrator/parallelResearch.js +24 -24
  157. package/dist/tools/convention/analyzeComplexity.test.js +115 -115
  158. package/dist/tools/convention/validateCodeQuality.test.js +104 -104
  159. package/dist/tools/memory/createMemoryTimeline.js +10 -10
  160. package/dist/tools/memory/getMemoryGraph.js +12 -12
  161. package/dist/tools/memory/getSessionContext.js +9 -9
  162. package/dist/tools/memory/linkMemories.js +14 -14
  163. package/dist/tools/memory/listMemories.js +4 -4
  164. package/dist/tools/memory/recallMemory.js +4 -4
  165. package/dist/tools/memory/saveMemory.js +4 -4
  166. package/dist/tools/memory/searchMemoriesAdvanced.js +23 -23
  167. package/dist/tools/semantic/analyzeDependencyGraph.js +12 -12
  168. package/dist/tools/semantic/astGrep.test.js +6 -6
  169. package/dist/tools/spec/prdParser.test.js +171 -171
  170. package/dist/tools/spec/specGenerator.js +169 -169
  171. package/dist/tools/spec/traceabilityMatrix.js +64 -64
  172. package/dist/tools/spec/traceabilityMatrix.test.js +28 -28
  173. package/hooks/gemini-hooks.json +73 -73
  174. package/hooks/hooks.json +126 -126
  175. package/hooks/scripts/__tests__/keyword-detector.test.js +199 -199
  176. package/hooks/scripts/__tests__/pre-tool-guard.test.js +287 -287
  177. package/hooks/scripts/__tests__/sentinel-guard.test.js +208 -208
  178. package/hooks/scripts/auto-commit.js +97 -97
  179. package/hooks/scripts/auto-format.js +64 -64
  180. package/hooks/scripts/auto-test.js +81 -81
  181. package/hooks/scripts/code-check.js +268 -268
  182. package/hooks/scripts/codex-detect.js +46 -46
  183. package/hooks/scripts/codex-review-gate.js +80 -80
  184. package/hooks/scripts/command-log.js +32 -32
  185. package/hooks/scripts/context-save.js +353 -353
  186. package/hooks/scripts/evolution-engine.js +91 -91
  187. package/hooks/scripts/figma-extract.js +635 -635
  188. package/hooks/scripts/figma-guard.js +219 -219
  189. package/hooks/scripts/figma-refine.js +315 -315
  190. package/hooks/scripts/figma-to-scss.js +394 -394
  191. package/hooks/scripts/figma-validate.js +353 -353
  192. package/hooks/scripts/hud-status.js +321 -321
  193. package/hooks/scripts/keyword-detector.js +214 -214
  194. package/hooks/scripts/llm-orchestrate.js +645 -645
  195. package/hooks/scripts/post-edit.js +32 -32
  196. package/hooks/scripts/pr-test-gate.js +52 -52
  197. package/hooks/scripts/pre-tool-guard.js +213 -213
  198. package/hooks/scripts/prompt-dispatcher.js +190 -190
  199. package/hooks/scripts/sentinel-guard.js +130 -130
  200. package/hooks/scripts/session-start.js +177 -177
  201. package/hooks/scripts/skill-injector.js +83 -83
  202. package/hooks/scripts/stop-notify.js +209 -209
  203. package/hooks/scripts/utils.js +257 -243
  204. package/languages/csharp-unity.md +515 -515
  205. package/languages/gdscript-godot.md +470 -470
  206. package/languages/ruby-rails.md +489 -489
  207. package/languages/typescript-angular.md +433 -433
  208. package/languages/typescript-astro.md +416 -416
  209. package/languages/typescript-electron.md +406 -406
  210. package/languages/typescript-nestjs.md +524 -524
  211. package/languages/typescript-svelte.md +407 -407
  212. package/languages/typescript-tauri.md +365 -365
  213. package/package.json +101 -101
  214. package/skills/agents-md/SKILL.md +121 -121
  215. package/skills/agents-md/rubrics/what-to-keep.md +49 -49
  216. package/skills/agents-md/templates/agents-md.md +36 -36
  217. package/skills/arch-guard/SKILL.md +181 -181
  218. package/skills/arch-guard/agents/detector.md +48 -48
  219. package/skills/arch-guard/agents/reporter.md +48 -48
  220. package/skills/arch-guard/agents/rule-generator.md +49 -49
  221. package/skills/arch-guard/agents/violation-checker.md +51 -51
  222. package/skills/arch-guard/frameworks/clean-architecture.md +108 -108
  223. package/skills/arch-guard/frameworks/solid.md +102 -102
  224. package/skills/arch-guard/scripts/check-boundaries.js +90 -90
  225. package/skills/arch-guard/templates/arch-rules.json +47 -47
  226. package/skills/arch-guard/templates/violation-report.md +53 -53
  227. package/skills/brand-assets/SKILL.md +147 -147
  228. package/skills/brand-assets/rubrics/asset-checklist.md +98 -98
  229. package/skills/brand-assets/templates/brand-guide.md +161 -161
  230. package/skills/capability-loop/SKILL.md +272 -272
  231. package/skills/capability-loop/agents/capability-designer.md +61 -61
  232. package/skills/capability-loop/agents/failure-analyst.md +55 -55
  233. package/skills/capability-loop/agents/implementer.md +50 -50
  234. package/skills/capability-loop/agents/tester.md +53 -53
  235. package/skills/capability-loop/templates/capability-spec.md +118 -118
  236. package/skills/capability-loop/templates/failure-analysis.md +118 -118
  237. package/skills/characterization-test/SKILL.md +207 -207
  238. package/skills/characterization-test/agents/behavior-capturer.md +50 -50
  239. package/skills/characterization-test/agents/coverage-checker.md +54 -54
  240. package/skills/characterization-test/agents/reporter.md +50 -50
  241. package/skills/characterization-test/agents/test-writer.md +49 -49
  242. package/skills/characterization-test/rubrics/coverage-criteria.md +53 -53
  243. package/skills/characterization-test/templates/test-template.ts +101 -101
  244. package/skills/chub-usage/SKILL.md +139 -139
  245. package/skills/claude-md-guide/SKILL.md +351 -351
  246. package/skills/claude-md-guide/rubrics/anti-patterns.md +88 -88
  247. package/skills/claude-md-guide/templates/claude-md.md +54 -54
  248. package/skills/commerce-patterns/SKILL.md +64 -64
  249. package/skills/commerce-patterns/rubrics/checkout-flow.md +48 -48
  250. package/skills/commerce-patterns/templates/product-schema.md +85 -85
  251. package/skills/commit-push-pr/SKILL.md +77 -77
  252. package/skills/commit-push-pr/agents/change-analyzer.md +55 -55
  253. package/skills/commit-push-pr/agents/message-writer.md +50 -50
  254. package/skills/commit-push-pr/agents/pr-writer.md +58 -58
  255. package/skills/commit-push-pr/agents/reviewer.md +52 -52
  256. package/skills/commit-push-pr/rubrics/commit-message.md +73 -73
  257. package/skills/commit-push-pr/templates/pr-body.md +63 -63
  258. package/skills/context7-usage/SKILL.md +106 -106
  259. package/skills/context7-usage/rubrics/when-to-use.md +50 -50
  260. package/skills/create-prd/SKILL.md +90 -90
  261. package/skills/create-prd/agents/edge-case-finder.md +48 -48
  262. package/skills/create-prd/agents/prioritizer.md +60 -60
  263. package/skills/create-prd/agents/requirements-writer.md +48 -48
  264. package/skills/create-prd/agents/researcher.md +55 -55
  265. package/skills/create-prd/agents/reviewer.md +54 -54
  266. package/skills/create-prd/frameworks/jobs-to-be-done.md +96 -96
  267. package/skills/create-prd/frameworks/rice-scoring.md +97 -97
  268. package/skills/create-prd/orchestrator.md +70 -70
  269. package/skills/create-prd/rubrics/completeness.md +58 -58
  270. package/skills/create-prd/templates/prd.md +139 -139
  271. package/skills/design-audit/SKILL.md +152 -152
  272. package/skills/design-audit/agents/a11y-auditor.md +43 -43
  273. package/skills/design-audit/agents/performance-auditor.md +46 -46
  274. package/skills/design-audit/agents/responsive-auditor.md +46 -46
  275. package/skills/design-audit/agents/scorer.md +47 -47
  276. package/skills/design-audit/agents/slop-detector.md +47 -47
  277. package/skills/design-audit/frameworks/core-web-vitals.md +107 -107
  278. package/skills/design-audit/frameworks/wcag-checklist.md +64 -64
  279. package/skills/design-audit/orchestrator.md +64 -64
  280. package/skills/design-audit/rubrics/ai-slop-patterns.md +83 -83
  281. package/skills/design-audit/rubrics/scoring.md +63 -63
  282. package/skills/design-audit/templates/report.md +88 -88
  283. package/skills/design-critique/SKILL.md +139 -139
  284. package/skills/design-critique/rubrics/ux-heuristics.md +143 -143
  285. package/skills/design-critique/templates/critique-report.md +86 -86
  286. package/skills/design-distill/SKILL.md +130 -130
  287. package/skills/design-distill/templates/design-system.md +132 -132
  288. package/skills/design-normalize/SKILL.md +133 -133
  289. package/skills/design-normalize/rubrics/token-naming.md +117 -117
  290. package/skills/design-normalize/templates/token-audit.md +89 -89
  291. package/skills/design-polish/SKILL.md +131 -131
  292. package/skills/design-polish/rubrics/polish-checklist.md +68 -68
  293. package/skills/design-polish/templates/polish-report.md +64 -64
  294. package/skills/design-teach/SKILL.md +182 -182
  295. package/skills/design-teach/rubrics/brand-personality.md +73 -73
  296. package/skills/design-teach/templates/design-context.json +36 -36
  297. package/skills/devlog/SKILL.md +143 -143
  298. package/skills/e2e-commerce/SKILL.md +62 -62
  299. package/skills/e2e-commerce/templates/test-scenarios.md +170 -170
  300. package/skills/event-comms/SKILL.md +172 -172
  301. package/skills/event-comms/templates/email-invite.md +99 -99
  302. package/skills/event-comms/templates/sns-post.md +133 -133
  303. package/skills/event-ops/SKILL.md +207 -207
  304. package/skills/event-ops/rubrics/contingency.md +85 -85
  305. package/skills/event-ops/templates/d-day-checklist.md +65 -65
  306. package/skills/event-planning/SKILL.md +144 -144
  307. package/skills/event-planning/rubrics/timeline.md +70 -70
  308. package/skills/event-planning/templates/event-plan.md +91 -91
  309. package/skills/exec-plan/SKILL.md +149 -149
  310. package/skills/exec-plan/agents/decomposer.md +47 -47
  311. package/skills/exec-plan/agents/dependency-mapper.md +44 -44
  312. package/skills/exec-plan/agents/estimator.md +43 -43
  313. package/skills/exec-plan/agents/validator.md +55 -55
  314. package/skills/exec-plan/orchestrator.md +70 -70
  315. package/skills/exec-plan/rubrics/complexity-scoring.md +75 -75
  316. package/skills/exec-plan/templates/plan.md +147 -147
  317. package/skills/git-worktree/SKILL.md +73 -73
  318. package/skills/git-worktree/rubrics/when-to-use.md +55 -55
  319. package/skills/handoff/SKILL.md +110 -110
  320. package/skills/handoff/agents/context-summarizer.md +51 -51
  321. package/skills/handoff/agents/document-writer.md +63 -63
  322. package/skills/handoff/agents/state-collector.md +53 -53
  323. package/skills/handoff/agents/verifier.md +48 -48
  324. package/skills/handoff/rubrics/completeness.md +62 -62
  325. package/skills/handoff/templates/handoff.md +107 -107
  326. package/skills/parallel-research/SKILL.md +104 -89
  327. package/skills/parallel-research/agents/best-practices.md +43 -43
  328. package/skills/parallel-research/agents/codebase-patterns.md +46 -46
  329. package/skills/parallel-research/agents/framework-docs.md +45 -45
  330. package/skills/parallel-research/agents/security-advisory.md +46 -46
  331. package/skills/parallel-research/agents/synthesizer.md +57 -52
  332. package/skills/parallel-research/experts/best-practices.md +50 -50
  333. package/skills/parallel-research/experts/codebase-patterns.md +70 -70
  334. package/skills/parallel-research/experts/framework-docs.md +65 -65
  335. package/skills/parallel-research/experts/security-advisory.md +69 -69
  336. package/skills/parallel-research/orchestrator.md +79 -65
  337. package/skills/parallel-research/templates/awesome-list.md +32 -0
  338. package/skills/parallel-research/templates/paper.md +88 -0
  339. package/skills/parallel-research/templates/synthesis.md +101 -101
  340. package/skills/prioritization-frameworks/SKILL.md +87 -87
  341. package/skills/prioritization-frameworks/rubrics/frameworks.md +79 -79
  342. package/skills/prioritization-frameworks/templates/scoring-matrix.md +69 -69
  343. package/skills/priority-todos/SKILL.md +64 -64
  344. package/skills/priority-todos/rubrics/prioritization.md +70 -70
  345. package/skills/priority-todos/templates/todo-board.md +59 -59
  346. package/skills/seo-checklist/SKILL.md +58 -58
  347. package/skills/seo-checklist/frameworks/structured-data.md +153 -153
  348. package/skills/seo-checklist/rubrics/content-seo.md +42 -42
  349. package/skills/seo-checklist/rubrics/technical-seo.md +48 -48
  350. package/skills/techdebt/SKILL.md +124 -124
  351. package/skills/techdebt/agents/analyzer.md +50 -50
  352. package/skills/techdebt/agents/fixer.md +41 -41
  353. package/skills/techdebt/agents/reviewer.md +47 -47
  354. package/skills/techdebt/agents/scanner.md +44 -44
  355. package/skills/techdebt/orchestrator.md +70 -70
  356. package/skills/techdebt/rubrics/severity.md +51 -51
  357. package/skills/techdebt/scripts/scan.js +90 -90
  358. package/skills/techdebt/templates/report.md +86 -86
  359. package/skills/tool-fallback/SKILL.md +104 -104
  360. package/skills/tool-fallback/rubrics/fallback-chain.md +58 -58
  361. package/skills/typescript-advanced-types/SKILL.md +67 -67
  362. package/skills/typescript-advanced-types/rubrics/type-patterns.md +109 -109
  363. package/skills/ui-ux-pro-max/SKILL.md +236 -236
  364. package/skills/ui-ux-pro-max/reference/color-and-contrast.md +517 -517
  365. package/skills/ui-ux-pro-max/reference/interaction-design.md +544 -544
  366. package/skills/ui-ux-pro-max/reference/motion-design.md +591 -591
  367. package/skills/ui-ux-pro-max/reference/responsive-design.md +463 -463
  368. package/skills/ui-ux-pro-max/reference/spatial-design.md +390 -390
  369. package/skills/ui-ux-pro-max/reference/typography.md +455 -455
  370. package/skills/ui-ux-pro-max/reference/ux-writing.md +469 -469
  371. package/skills/ui-ux-pro-max/rubrics/interaction-states.md +83 -83
  372. package/skills/ui-ux-pro-max/rubrics/responsive-breakpoints.md +99 -99
  373. package/skills/user-personas/SKILL.md +75 -75
  374. package/skills/user-personas/rubrics/research-methods.md +56 -56
  375. package/skills/user-personas/templates/persona.md +89 -89
  376. package/skills/vercel-react-best-practices/SKILL.md +60 -60
  377. package/skills/vercel-react-best-practices/rubrics/performance.md +82 -82
  378. package/skills/vercel-react-best-practices/rubrics/server-components.md +86 -86
  379. package/skills/vibe-contract/SKILL.md +166 -0
  380. package/skills/vibe-docs/templates/architecture.md +80 -80
  381. package/skills/vibe-docs/templates/readme.md +84 -84
  382. package/skills/vibe-docs/templates/release-notes.md +74 -74
  383. package/skills/vibe-figma/SKILL.md +363 -363
  384. package/skills/vibe-figma/rubrics/extraction-checklist.md +51 -51
  385. package/skills/vibe-figma/templates/component-index.md +126 -126
  386. package/skills/vibe-figma/templates/component-spec.md +168 -168
  387. package/skills/vibe-figma/templates/figma-handoff.md +100 -100
  388. package/skills/vibe-figma/templates/remapped-tree.md +277 -277
  389. package/skills/vibe-figma-convert/SKILL.md +235 -235
  390. package/skills/vibe-figma-convert/rubrics/conversion-rules.md +141 -141
  391. package/skills/vibe-figma-convert/templates/component.md +140 -140
  392. package/skills/vibe-figma-extract/SKILL.md +219 -219
  393. package/skills/vibe-figma-extract/rubrics/image-rules.md +157 -157
  394. package/skills/vibe-interview/SKILL.md +358 -358
  395. package/skills/vibe-interview/checklists/api.md +101 -101
  396. package/skills/vibe-interview/checklists/feature.md +88 -88
  397. package/skills/vibe-interview/checklists/library.md +95 -95
  398. package/skills/vibe-interview/checklists/mobile.md +89 -89
  399. package/skills/vibe-interview/checklists/webapp.md +97 -97
  400. package/skills/vibe-interview/checklists/website.md +99 -99
  401. package/skills/vibe-plan/SKILL.md +254 -254
  402. package/skills/vibe-regress/SKILL.md +174 -0
  403. package/skills/vibe-regress/templates/bug.md +44 -0
  404. package/skills/vibe-regress/templates/test-jest.md +29 -0
  405. package/skills/vibe-regress/templates/test-vitest.md +30 -0
  406. package/skills/vibe-spec/SKILL.md +1195 -1155
  407. package/skills/vibe-spec-review/SKILL.md +726 -726
  408. package/skills/video-production/SKILL.md +52 -52
  409. package/skills/video-production/rubrics/quality-checklist.md +58 -58
  410. package/skills/video-production/templates/production-plan.md +104 -104
  411. package/vibe/config.json +29 -29
  412. package/vibe/constitution.md +227 -227
  413. package/vibe/rules/principles/communication-guide.md +98 -98
  414. package/vibe/rules/principles/development-philosophy.md +52 -52
  415. package/vibe/rules/principles/quick-start.md +102 -102
  416. package/vibe/rules/quality/bdd-contract-testing.md +393 -393
  417. package/vibe/rules/quality/checklist.md +276 -276
  418. package/vibe/rules/quality/performance.md +236 -236
  419. package/vibe/rules/quality/testing-strategy.md +440 -440
  420. package/vibe/rules/standards/anti-patterns.md +541 -541
  421. package/vibe/rules/standards/code-structure.md +291 -291
  422. package/vibe/rules/standards/complexity-metrics.md +313 -313
  423. package/vibe/rules/standards/git-workflow.md +237 -237
  424. package/vibe/rules/standards/naming-conventions.md +198 -198
  425. package/vibe/rules/standards/security.md +305 -305
  426. package/vibe/rules/writing/document-style.md +74 -74
  427. package/vibe/setup.sh +31 -31
  428. package/vibe/templates/claudemd-template.md +74 -74
  429. package/vibe/templates/constitution-template.md +267 -267
  430. package/vibe/templates/contract-backend-template.md +526 -526
  431. package/vibe/templates/contract-frontend-template.md +599 -599
  432. package/vibe/templates/feature-template.md +96 -96
  433. package/vibe/templates/plan-template.md +194 -194
  434. package/vibe/templates/spec-template.md +221 -221
  435. package/vibe/ui-ux-data/charts.csv +26 -26
  436. package/vibe/ui-ux-data/colors.csv +97 -97
  437. package/vibe/ui-ux-data/icons.csv +101 -101
  438. package/vibe/ui-ux-data/landing.csv +31 -31
  439. package/vibe/ui-ux-data/products.csv +96 -96
  440. package/vibe/ui-ux-data/react-performance.csv +45 -45
  441. package/vibe/ui-ux-data/stacks/astro.csv +54 -54
  442. package/vibe/ui-ux-data/stacks/flutter.csv +53 -53
  443. package/vibe/ui-ux-data/stacks/html-tailwind.csv +56 -56
  444. package/vibe/ui-ux-data/stacks/jetpack-compose.csv +53 -53
  445. package/vibe/ui-ux-data/stacks/nextjs.csv +53 -53
  446. package/vibe/ui-ux-data/stacks/nuxt-ui.csv +51 -51
  447. package/vibe/ui-ux-data/stacks/nuxtjs.csv +59 -59
  448. package/vibe/ui-ux-data/stacks/react-native.csv +52 -52
  449. package/vibe/ui-ux-data/stacks/react.csv +54 -54
  450. package/vibe/ui-ux-data/stacks/shadcn.csv +61 -61
  451. package/vibe/ui-ux-data/stacks/svelte.csv +54 -54
  452. package/vibe/ui-ux-data/stacks/swiftui.csv +51 -51
  453. package/vibe/ui-ux-data/stacks/vue.csv +50 -50
  454. package/vibe/ui-ux-data/styles.csv +68 -68
  455. package/vibe/ui-ux-data/typography.csv +57 -57
  456. package/vibe/ui-ux-data/ui-reasoning.csv +101 -101
  457. package/vibe/ui-ux-data/ux-guidelines.csv +99 -99
  458. package/vibe/ui-ux-data/version.json +31 -31
  459. package/vibe/ui-ux-data/web-interface.csv +31 -31
@@ -0,0 +1,166 @@
1
+ ---
2
+ name: vibe-contract
3
+ tier: core
4
+ description: "API contract drift detection. Extracts HTTP/GraphQL/event/public-function contracts from SPEC into .claude/vibe/contracts/<feature>.md, compares to implementation, and fails loudly on breaking drift (missing endpoints, removed required fields, type changes). P1 drifts auto-register as regressions via vibe-regress. Must use this skill when user runs /vibe.contract, when /vibe.spec completes, when /vibe.verify passes scenarios, or when the user says 'contract', 'API schema', 'breaking change', 'drift', '계약', '스키마 바뀜'."
5
+ triggers: [contract, drift, "계약", "API 변경", "breaking change", "schema drift"]
6
+ priority: 70
7
+ chain-next: []
8
+ ---
9
+
10
+ # vibe.contract — API Contract Drift Detection
11
+
12
+ **Purpose**: SPEC에 적힌 외부 계약과 실제 구현이 어긋나면 즉시 잡는다. 테스트 통과 ≠ 계약 준수.
13
+
14
+ ## Why this exists
15
+
16
+ 바이브코딩의 숨은 약점: 구현이 자라면서 SPEC에 명시된 응답 shape에서 조용히 벗어난다. 시나리오 테스트는 통과해도 **외부 소비자는 깨진다**. 사람이 매번 SPEC을 비교하기엔 마찰이 크므로 기계화.
17
+
18
+ ## Storage Contract
19
+
20
+ ```
21
+ .claude/vibe/contracts/
22
+ <feature>.md # 계약 SSOT (SPEC에서 추출)
23
+ <feature>.snapshot.md # 구현 스냅샷 (마지막 check 시점)
24
+ ```
25
+
26
+ ### Contract frontmatter schema
27
+
28
+ ```yaml
29
+ ---
30
+ feature: string
31
+ extracted-from: .claude/vibe/specs/<feature>.md
32
+ extracted-at: ISO-8601
33
+ source-spec-hash: sha256 # SPEC 변경 감지용
34
+ endpoints:
35
+ - id: unique-kebab-id # 예: get-user-by-id
36
+ kind: http | graphql | event | function
37
+ # http
38
+ method: GET | POST | PUT | DELETE | PATCH
39
+ path: /users/:id
40
+ request:
41
+ params: { name: type, ... }
42
+ query: { name: type, ... }
43
+ body: { field: type, ... } | null
44
+ required: [field, ...]
45
+ response:
46
+ statusCodes:
47
+ 200: { schema }
48
+ 404: { error: string }
49
+ required-fields:
50
+ 200: [id, email]
51
+ # graphql
52
+ operation: query | mutation
53
+ name: string
54
+ args: { ... }
55
+ returns: { ... }
56
+ # event
57
+ topic: string
58
+ payload: { ... }
59
+ # function
60
+ signature: "(a: string, b: number) => Promise<User>"
61
+ module: path/to/file.ts
62
+ ---
63
+ ```
64
+
65
+ ## Subcommands
66
+
67
+ ### 1. `extract <feature>` — SPEC에서 계약 추출
68
+
69
+ **단계**:
70
+ 1. SPEC 파일 로드 (single file or split folder)
71
+ 2. 다음 섹션을 순서대로 탐색:
72
+ - `## API` / `## Endpoints` / `## Interface` / `## Contract`
73
+ - Markdown 테이블 (method/path/request/response 헤더)
74
+ - 코드 블록 안의 OpenAPI/JSON Schema 스니펫
75
+ 3. 추출 실패(해당 섹션 없음) → **에러 없이 `no-contract` 상태 기록 후 종료**. 모든 feature가 API를 갖진 않음.
76
+ 4. 추출 성공 → frontmatter 구조로 변환
77
+ 5. `source-spec-hash`: SPEC 파일 내용의 sha256 (다음 extract 시 변경 감지)
78
+ 6. `.claude/vibe/contracts/<feature>.md` 저장 (기존 파일이 있고 hash가 같으면 **no-op**)
79
+
80
+ **주의**: 추출은 LLM 파싱. 신뢰도 낮은 필드는 `# unconfirmed` 주석 달아서 사용자가 검토 가능하게.
81
+
82
+ ### 2. `check <feature>` — 계약 vs 구현 비교
83
+
84
+ **단계**:
85
+ 1. `.claude/vibe/contracts/<feature>.md` 로드. 없으면 **먼저 extract 제안**.
86
+ 2. 각 endpoint에 대해 구현 탐색:
87
+ - http: 프레임워크 감지 (Express, Fastify, Next.js API routes, Hono, ...)
88
+ - graphql: resolver 파일 찾기
89
+ - event: 프로듀서/컨슈머 코드
90
+ - function: 모듈 export
91
+ 3. 구현 시그니처/스키마를 추출 → 계약과 비교
92
+ 4. Drift 분류 (severity 표는 command file 참고)
93
+ 5. 스냅샷 저장: `.claude/vibe/contracts/<feature>.snapshot.md` (현재 구현 상태)
94
+
95
+ ### 3. `diff <feature>` — 이전 스냅샷 대비 변경만
96
+
97
+ **단계**:
98
+ 1. `.snapshot.md`가 없으면 "첫 실행" 안내 후 종료
99
+ 2. 현재 구현 재추출 vs 기존 스냅샷 비교
100
+ 3. **변경된 필드만** 출력 (ASCII diff 형식):
101
+ ```
102
+ endpoints/get-user-by-id/response/200:
103
+ - email: string
104
+ + email: string | null ← nullability 추가 (P1 breaking)
105
+ + phoneNumber: string ← 신규 필드 (P3 safe)
106
+ ```
107
+ 4. 드리프트 있으면 `/vibe.regress register --from-contract` 자동 호출
108
+
109
+ ## Drift Severity Matrix
110
+
111
+ (command file의 표와 동일 — 변경 시 양쪽 갱신)
112
+
113
+ ## Integration Points
114
+
115
+ ### From /vibe.spec
116
+
117
+ SPEC 작성 완료 직후 자동 호출:
118
+ ```
119
+ Load skill `vibe-contract` with: extract <feature>
120
+ ```
121
+ 실패해도 `/vibe.spec`은 계속 진행 (계약 추출은 옵션). 단 성공 시 `/vibe.run`이 이 계약을 참조.
122
+
123
+ ### From /vibe.verify
124
+
125
+ 모든 scenario pass 후 자동 체인:
126
+ ```
127
+ Load skill `vibe-contract` with: check <feature>
128
+ ```
129
+ - drift 없음 → verify 통과 유지
130
+ - P1 drift → verify 실패로 강등, regress 자동 등록
131
+ - P2/P3 drift → 경고만, verify 통과 유지
132
+
133
+ ### To /vibe.regress
134
+
135
+ P1 drift 발견 시:
136
+ ```
137
+ Load skill `vibe-regress` with:
138
+ subcommand: register --from-contract
139
+ feature: <feature>
140
+ symptom: "Contract drift: <endpoint-id> <drift-type>"
141
+ root-cause-tag: integration
142
+ ```
143
+
144
+ ## Framework Detection Rules
145
+
146
+ HTTP framework 감지 순서:
147
+ 1. `package.json` dependencies에서: `next` → Next.js API routes
148
+ 2. `fastify` → Fastify
149
+ 3. `express` → Express
150
+ 4. `hono` → Hono
151
+ 5. `@nestjs/core` → NestJS
152
+ 6. 감지 실패 → user에게 질문 후 manual mapping
153
+
154
+ 감지 후 각 프레임워크의 **라우트 정의 패턴**을 Grep으로 찾아 endpoint 매핑:
155
+ - Next.js: `pages/api/**` or `app/api/**/route.ts`
156
+ - Express: `app.get|post|put|delete|patch\(`
157
+ - Fastify: `fastify.get|post|...` or route configuration
158
+ - Hono: `app.get|post|...`
159
+
160
+ ## Done Criteria
161
+
162
+ - [ ] `extract`가 API 섹션 없는 SPEC에서 에러 내지 않음
163
+ - [ ] `source-spec-hash` 기반 re-extract 스킵
164
+ - [ ] `check`는 각 drift에 severity + 위치(file:line) 명시
165
+ - [ ] P1 drift는 100% `/vibe.regress` 자동 등록
166
+ - [ ] 프레임워크 감지 실패 시 silently skip 금지 — 반드시 user 질문
@@ -1,80 +1,80 @@
1
- # Architecture: {{PROJECT_NAME}}
2
-
3
- > Version: {{VERSION}} | Updated: {{DATE}}
4
-
5
- ## Overview
6
-
7
- {{2-3 SENTENCES: WHAT THIS SYSTEM DOES AND ITS PRIMARY ARCHITECTURAL APPROACH.}}
8
-
9
- ## System Diagram
10
-
11
- ```mermaid
12
- graph TD
13
- {{ENTRY_POINT}}[{{ENTRY_LABEL}}] --> {{MODULE_A}}[{{MODULE_A_LABEL}}]
14
- {{MODULE_A}} --> {{MODULE_B}}[{{MODULE_B_LABEL}}]
15
- {{MODULE_A}} --> {{MODULE_C}}[{{MODULE_C_LABEL}}]
16
- {{MODULE_B}} --> {{STORE}}[({{STORE_LABEL}})]
17
- {{MODULE_C}} --> {{EXTERNAL}}[{{EXTERNAL_SERVICE_LABEL}}]
18
- ```
19
-
20
- > Replace nodes above based on actual `import` analysis. Run:
21
- > `grep -r "^import .* from" src/ | sed 's/.*from //' | sort | uniq` to get dependency edges.
22
-
23
- ## Module Responsibilities
24
-
25
- | Module / Directory | Responsibility | Key Files |
26
- |--------------------|---------------|-----------|
27
- | `{{MODULE_1}}/` | {{RESPONSIBILITY}} | `{{KEY_FILE}}` |
28
- | `{{MODULE_2}}/` | {{RESPONSIBILITY}} | `{{KEY_FILE}}` |
29
- | `{{MODULE_3}}/` | {{RESPONSIBILITY}} | `{{KEY_FILE}}` |
30
-
31
- ## Data Flow
32
-
33
- ```
34
- {{INPUT_SOURCE}}
35
- ↓ {{STEP_1_DESCRIPTION}}
36
- {{PROCESSING_MODULE}}
37
- ↓ {{STEP_2_DESCRIPTION}}
38
- {{OUTPUT_TARGET}}
39
- ```
40
-
41
- ### Key Data Entities
42
-
43
- | Entity | Where Defined | Storage |
44
- |--------|--------------|---------|
45
- | `{{ENTITY_1}}` | `{{FILE_PATH}}` | {{DB / FILE / MEMORY}} |
46
- | `{{ENTITY_2}}` | `{{FILE_PATH}}` | {{DB / FILE / MEMORY}} |
47
-
48
- ## External Dependencies
49
-
50
- | Service | Purpose | Auth Method |
51
- |---------|---------|-------------|
52
- | `{{SERVICE_1}}` | {{PURPOSE}} | {{API_KEY / OAUTH / NONE}} |
53
- | `{{SERVICE_2}}` | {{PURPOSE}} | {{AUTH_METHOD}} |
54
-
55
- ## Key Decisions
56
-
57
- | Decision | Chosen Approach | Alternatives Considered | Rationale |
58
- |----------|----------------|------------------------|-----------|
59
- | {{DECISION_1}} | {{CHOICE}} | {{ALTERNATIVES}} | {{WHY}} |
60
- | {{DECISION_2}} | {{CHOICE}} | {{ALTERNATIVES}} | {{WHY}} |
61
-
62
- ## Constraints & Non-Goals
63
-
64
- **Constraints:**
65
- - {{CONSTRAINT_1}} (e.g., "Must work offline")
66
- - {{CONSTRAINT_2}}
67
-
68
- **Non-goals (out of scope):**
69
- - {{NON_GOAL_1}}
70
- - {{NON_GOAL_2}}
71
-
72
- ## Local Development Setup
73
-
74
- ```bash
75
- {{SETUP_COMMANDS}}
76
- ```
77
-
78
- ## Further Reading
79
-
80
- - {{INTERNAL_LINK_OR_DOC}}
1
+ # Architecture: {{PROJECT_NAME}}
2
+
3
+ > Version: {{VERSION}} | Updated: {{DATE}}
4
+
5
+ ## Overview
6
+
7
+ {{2-3 SENTENCES: WHAT THIS SYSTEM DOES AND ITS PRIMARY ARCHITECTURAL APPROACH.}}
8
+
9
+ ## System Diagram
10
+
11
+ ```mermaid
12
+ graph TD
13
+ {{ENTRY_POINT}}[{{ENTRY_LABEL}}] --> {{MODULE_A}}[{{MODULE_A_LABEL}}]
14
+ {{MODULE_A}} --> {{MODULE_B}}[{{MODULE_B_LABEL}}]
15
+ {{MODULE_A}} --> {{MODULE_C}}[{{MODULE_C_LABEL}}]
16
+ {{MODULE_B}} --> {{STORE}}[({{STORE_LABEL}})]
17
+ {{MODULE_C}} --> {{EXTERNAL}}[{{EXTERNAL_SERVICE_LABEL}}]
18
+ ```
19
+
20
+ > Replace nodes above based on actual `import` analysis. Run:
21
+ > `grep -r "^import .* from" src/ | sed 's/.*from //' | sort | uniq` to get dependency edges.
22
+
23
+ ## Module Responsibilities
24
+
25
+ | Module / Directory | Responsibility | Key Files |
26
+ |--------------------|---------------|-----------|
27
+ | `{{MODULE_1}}/` | {{RESPONSIBILITY}} | `{{KEY_FILE}}` |
28
+ | `{{MODULE_2}}/` | {{RESPONSIBILITY}} | `{{KEY_FILE}}` |
29
+ | `{{MODULE_3}}/` | {{RESPONSIBILITY}} | `{{KEY_FILE}}` |
30
+
31
+ ## Data Flow
32
+
33
+ ```
34
+ {{INPUT_SOURCE}}
35
+ ↓ {{STEP_1_DESCRIPTION}}
36
+ {{PROCESSING_MODULE}}
37
+ ↓ {{STEP_2_DESCRIPTION}}
38
+ {{OUTPUT_TARGET}}
39
+ ```
40
+
41
+ ### Key Data Entities
42
+
43
+ | Entity | Where Defined | Storage |
44
+ |--------|--------------|---------|
45
+ | `{{ENTITY_1}}` | `{{FILE_PATH}}` | {{DB / FILE / MEMORY}} |
46
+ | `{{ENTITY_2}}` | `{{FILE_PATH}}` | {{DB / FILE / MEMORY}} |
47
+
48
+ ## External Dependencies
49
+
50
+ | Service | Purpose | Auth Method |
51
+ |---------|---------|-------------|
52
+ | `{{SERVICE_1}}` | {{PURPOSE}} | {{API_KEY / OAUTH / NONE}} |
53
+ | `{{SERVICE_2}}` | {{PURPOSE}} | {{AUTH_METHOD}} |
54
+
55
+ ## Key Decisions
56
+
57
+ | Decision | Chosen Approach | Alternatives Considered | Rationale |
58
+ |----------|----------------|------------------------|-----------|
59
+ | {{DECISION_1}} | {{CHOICE}} | {{ALTERNATIVES}} | {{WHY}} |
60
+ | {{DECISION_2}} | {{CHOICE}} | {{ALTERNATIVES}} | {{WHY}} |
61
+
62
+ ## Constraints & Non-Goals
63
+
64
+ **Constraints:**
65
+ - {{CONSTRAINT_1}} (e.g., "Must work offline")
66
+ - {{CONSTRAINT_2}}
67
+
68
+ **Non-goals (out of scope):**
69
+ - {{NON_GOAL_1}}
70
+ - {{NON_GOAL_2}}
71
+
72
+ ## Local Development Setup
73
+
74
+ ```bash
75
+ {{SETUP_COMMANDS}}
76
+ ```
77
+
78
+ ## Further Reading
79
+
80
+ - {{INTERNAL_LINK_OR_DOC}}
@@ -1,84 +1,84 @@
1
- # {{PROJECT_NAME}}
2
-
3
- > {{ONE_LINE_DESCRIPTION_FROM_PACKAGE_JSON}}
4
-
5
- ## What is this?
6
-
7
- {{2-3 SENTENCES: THE PROBLEM THIS PROJECT SOLVES AND HOW IT SOLVES IT.}}
8
-
9
- ## Quick Start
10
-
11
- ```bash
12
- # Install
13
- {{PACKAGE_MANAGER}} install {{PACKAGE_NAME}}
14
-
15
- # Minimal usage example
16
- {{USAGE_EXAMPLE}}
17
- ```
18
-
19
- ## Features
20
-
21
- - **{{FEATURE_1}}** — {{BRIEF_DESCRIPTION}}
22
- - **{{FEATURE_2}}** — {{BRIEF_DESCRIPTION}}
23
- - **{{FEATURE_3}}** — {{BRIEF_DESCRIPTION}}
24
-
25
- ## Architecture
26
-
27
- > Include this section if the project has 5+ source directories.
28
-
29
- ```
30
- {{PROJECT_NAME}}/
31
- ├── {{DIR_1}}/ # {{RESPONSIBILITY_1}}
32
- ├── {{DIR_2}}/ # {{RESPONSIBILITY_2}}
33
- └── {{DIR_3}}/ # {{RESPONSIBILITY_3}}
34
- ```
35
-
36
- ## Configuration
37
-
38
- | File | Purpose |
39
- |------|---------|
40
- | `{{CONFIG_FILE_1}}` | {{PURPOSE}} |
41
- | `{{CONFIG_FILE_2}}` | {{PURPOSE}} |
42
-
43
- **Key environment variables:**
44
-
45
- | Variable | Required | Default | Description |
46
- |----------|----------|---------|-------------|
47
- | `{{ENV_VAR_1}}` | Yes / No | `{{DEFAULT}}` | {{DESCRIPTION}} |
48
-
49
- ## Development
50
-
51
- ```bash
52
- # Install dependencies
53
- {{INSTALL_COMMAND}}
54
-
55
- # Build
56
- {{BUILD_COMMAND}}
57
-
58
- # Test
59
- {{TEST_COMMAND}}
60
-
61
- # Lint
62
- {{LINT_COMMAND}}
63
- ```
64
-
65
- ## API Reference
66
-
67
- > Include if the project exposes a public API.
68
-
69
- ### `{{FUNCTION_OR_CLASS_NAME}}`
70
-
71
- ```typescript
72
- {{FUNCTION_SIGNATURE}}
73
- ```
74
-
75
- {{DESCRIPTION}}
76
-
77
- **Parameters:**
78
- - `{{PARAM_1}}` — {{TYPE}}: {{DESCRIPTION}}
79
-
80
- **Returns:** `{{RETURN_TYPE}}` — {{DESCRIPTION}}
81
-
82
- ## License
83
-
84
- {{LICENSE}} — see [LICENSE](./LICENSE)
1
+ # {{PROJECT_NAME}}
2
+
3
+ > {{ONE_LINE_DESCRIPTION_FROM_PACKAGE_JSON}}
4
+
5
+ ## What is this?
6
+
7
+ {{2-3 SENTENCES: THE PROBLEM THIS PROJECT SOLVES AND HOW IT SOLVES IT.}}
8
+
9
+ ## Quick Start
10
+
11
+ ```bash
12
+ # Install
13
+ {{PACKAGE_MANAGER}} install {{PACKAGE_NAME}}
14
+
15
+ # Minimal usage example
16
+ {{USAGE_EXAMPLE}}
17
+ ```
18
+
19
+ ## Features
20
+
21
+ - **{{FEATURE_1}}** — {{BRIEF_DESCRIPTION}}
22
+ - **{{FEATURE_2}}** — {{BRIEF_DESCRIPTION}}
23
+ - **{{FEATURE_3}}** — {{BRIEF_DESCRIPTION}}
24
+
25
+ ## Architecture
26
+
27
+ > Include this section if the project has 5+ source directories.
28
+
29
+ ```
30
+ {{PROJECT_NAME}}/
31
+ ├── {{DIR_1}}/ # {{RESPONSIBILITY_1}}
32
+ ├── {{DIR_2}}/ # {{RESPONSIBILITY_2}}
33
+ └── {{DIR_3}}/ # {{RESPONSIBILITY_3}}
34
+ ```
35
+
36
+ ## Configuration
37
+
38
+ | File | Purpose |
39
+ |------|---------|
40
+ | `{{CONFIG_FILE_1}}` | {{PURPOSE}} |
41
+ | `{{CONFIG_FILE_2}}` | {{PURPOSE}} |
42
+
43
+ **Key environment variables:**
44
+
45
+ | Variable | Required | Default | Description |
46
+ |----------|----------|---------|-------------|
47
+ | `{{ENV_VAR_1}}` | Yes / No | `{{DEFAULT}}` | {{DESCRIPTION}} |
48
+
49
+ ## Development
50
+
51
+ ```bash
52
+ # Install dependencies
53
+ {{INSTALL_COMMAND}}
54
+
55
+ # Build
56
+ {{BUILD_COMMAND}}
57
+
58
+ # Test
59
+ {{TEST_COMMAND}}
60
+
61
+ # Lint
62
+ {{LINT_COMMAND}}
63
+ ```
64
+
65
+ ## API Reference
66
+
67
+ > Include if the project exposes a public API.
68
+
69
+ ### `{{FUNCTION_OR_CLASS_NAME}}`
70
+
71
+ ```typescript
72
+ {{FUNCTION_SIGNATURE}}
73
+ ```
74
+
75
+ {{DESCRIPTION}}
76
+
77
+ **Parameters:**
78
+ - `{{PARAM_1}}` — {{TYPE}}: {{DESCRIPTION}}
79
+
80
+ **Returns:** `{{RETURN_TYPE}}` — {{DESCRIPTION}}
81
+
82
+ ## License
83
+
84
+ {{LICENSE}} — see [LICENSE](./LICENSE)
@@ -1,74 +1,74 @@
1
- # Release Notes: {{PROJECT_NAME}}
2
-
3
- ---
4
-
5
- ## [{{VERSION}}] — {{RELEASE_DATE}}
6
-
7
- > {{ONE_SENTENCE_SUMMARY_OF_THIS_RELEASE}}
8
-
9
- ### Breaking Changes
10
-
11
- > If none, remove this section.
12
-
13
- - **{{CHANGE_DESCRIPTION}}** — {{MIGRATION_GUIDE}}
14
- - Before: `{{OLD_USAGE}}`
15
- - After: `{{NEW_USAGE}}`
16
-
17
- ### Features
18
-
19
- - `feat`: {{FEATURE_DESCRIPTION}} ([#{{PR_NUMBER}}]({{PR_URL}}))
20
- - `feat`: {{FEATURE_DESCRIPTION}} ([#{{PR_NUMBER}}]({{PR_URL}}))
21
-
22
- ### Bug Fixes
23
-
24
- - `fix`: {{BUG_DESCRIPTION}} — {{WHAT_WAS_WRONG_AND_HOW_FIXED}} ([#{{PR_NUMBER}}]({{PR_URL}}))
25
-
26
- ### Performance
27
-
28
- - `perf`: {{IMPROVEMENT_DESCRIPTION}} — {{BEFORE}} → {{AFTER}}
29
-
30
- ### Other
31
-
32
- - `refactor`: {{DESCRIPTION}}
33
- - `docs`: {{DESCRIPTION}}
34
- - `chore`: {{DESCRIPTION}}
35
-
36
- ---
37
-
38
- ## Upgrade Guide
39
-
40
- ### From {{PREVIOUS_VERSION}} to {{VERSION}}
41
-
42
- ```bash
43
- {{UPGRADE_COMMAND}}
44
- ```
45
-
46
- **Required config changes:**
47
- 1. {{CONFIG_CHANGE_1}}
48
- 2. {{CONFIG_CHANGE_2}}
49
-
50
- ---
51
-
52
- ## [{{PREVIOUS_VERSION}}] — {{PREVIOUS_DATE}}
53
-
54
- > Past release notes continue below in reverse chronological order.
55
-
56
- ---
57
-
58
- <!-- GENERATION NOTES (remove before publishing)
59
-
60
- Run to generate draft:
61
- git log {{PREVIOUS_TAG}}..HEAD --oneline --no-merges
62
-
63
- Classify commits:
64
- feat: → Features
65
- fix: → Bug Fixes
66
- perf: → Performance
67
- refactor/docs/chore/test: → Other
68
- BREAKING CHANGE in footer: → Breaking Changes
69
-
70
- Version bump guidance:
71
- Breaking changes → major (x.0.0)
72
- New features → minor (0.x.0)
73
- Bug fixes only → patch (0.0.x)
74
- -->
1
+ # Release Notes: {{PROJECT_NAME}}
2
+
3
+ ---
4
+
5
+ ## [{{VERSION}}] — {{RELEASE_DATE}}
6
+
7
+ > {{ONE_SENTENCE_SUMMARY_OF_THIS_RELEASE}}
8
+
9
+ ### Breaking Changes
10
+
11
+ > If none, remove this section.
12
+
13
+ - **{{CHANGE_DESCRIPTION}}** — {{MIGRATION_GUIDE}}
14
+ - Before: `{{OLD_USAGE}}`
15
+ - After: `{{NEW_USAGE}}`
16
+
17
+ ### Features
18
+
19
+ - `feat`: {{FEATURE_DESCRIPTION}} ([#{{PR_NUMBER}}]({{PR_URL}}))
20
+ - `feat`: {{FEATURE_DESCRIPTION}} ([#{{PR_NUMBER}}]({{PR_URL}}))
21
+
22
+ ### Bug Fixes
23
+
24
+ - `fix`: {{BUG_DESCRIPTION}} — {{WHAT_WAS_WRONG_AND_HOW_FIXED}} ([#{{PR_NUMBER}}]({{PR_URL}}))
25
+
26
+ ### Performance
27
+
28
+ - `perf`: {{IMPROVEMENT_DESCRIPTION}} — {{BEFORE}} → {{AFTER}}
29
+
30
+ ### Other
31
+
32
+ - `refactor`: {{DESCRIPTION}}
33
+ - `docs`: {{DESCRIPTION}}
34
+ - `chore`: {{DESCRIPTION}}
35
+
36
+ ---
37
+
38
+ ## Upgrade Guide
39
+
40
+ ### From {{PREVIOUS_VERSION}} to {{VERSION}}
41
+
42
+ ```bash
43
+ {{UPGRADE_COMMAND}}
44
+ ```
45
+
46
+ **Required config changes:**
47
+ 1. {{CONFIG_CHANGE_1}}
48
+ 2. {{CONFIG_CHANGE_2}}
49
+
50
+ ---
51
+
52
+ ## [{{PREVIOUS_VERSION}}] — {{PREVIOUS_DATE}}
53
+
54
+ > Past release notes continue below in reverse chronological order.
55
+
56
+ ---
57
+
58
+ <!-- GENERATION NOTES (remove before publishing)
59
+
60
+ Run to generate draft:
61
+ git log {{PREVIOUS_TAG}}..HEAD --oneline --no-merges
62
+
63
+ Classify commits:
64
+ feat: → Features
65
+ fix: → Bug Fixes
66
+ perf: → Performance
67
+ refactor/docs/chore/test: → Other
68
+ BREAKING CHANGE in footer: → Breaking Changes
69
+
70
+ Version bump guidance:
71
+ Breaking changes → major (x.0.0)
72
+ New features → minor (0.x.0)
73
+ Bug fixes only → patch (0.0.x)
74
+ -->