musubi-sdd 5.0.0 → 5.6.1

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 (232) hide show
  1. package/README.ja.md +106 -48
  2. package/README.md +110 -32
  3. package/bin/musubi-analyze.js +74 -67
  4. package/bin/musubi-browser.js +27 -26
  5. package/bin/musubi-change.js +48 -47
  6. package/bin/musubi-checkpoint.js +10 -7
  7. package/bin/musubi-convert.js +25 -25
  8. package/bin/musubi-costs.js +27 -10
  9. package/bin/musubi-gui.js +52 -46
  10. package/bin/musubi-init.js +1952 -10
  11. package/bin/musubi-orchestrate.js +327 -239
  12. package/bin/musubi-remember.js +69 -56
  13. package/bin/musubi-resolve.js +53 -45
  14. package/bin/musubi-trace.js +51 -22
  15. package/bin/musubi-validate.js +39 -30
  16. package/bin/musubi-workflow.js +33 -34
  17. package/bin/musubi.js +39 -2
  18. package/package.json +1 -1
  19. package/src/agents/agent-loop.js +94 -95
  20. package/src/agents/agentic/code-generator.js +119 -109
  21. package/src/agents/agentic/code-reviewer.js +105 -108
  22. package/src/agents/agentic/index.js +4 -4
  23. package/src/agents/browser/action-executor.js +13 -13
  24. package/src/agents/browser/ai-comparator.js +11 -10
  25. package/src/agents/browser/context-manager.js +6 -6
  26. package/src/agents/browser/index.js +5 -5
  27. package/src/agents/browser/nl-parser.js +31 -46
  28. package/src/agents/browser/screenshot.js +2 -2
  29. package/src/agents/browser/test-generator.js +6 -4
  30. package/src/agents/function-tool.js +71 -65
  31. package/src/agents/index.js +7 -7
  32. package/src/agents/schema-generator.js +98 -94
  33. package/src/analyzers/ast-extractor.js +164 -145
  34. package/src/analyzers/codegraph-auto-update.js +858 -0
  35. package/src/analyzers/complexity-analyzer.js +536 -0
  36. package/src/analyzers/context-optimizer.js +247 -125
  37. package/src/analyzers/impact-analyzer.js +1 -1
  38. package/src/analyzers/large-project-analyzer.js +766 -0
  39. package/src/analyzers/repository-map.js +83 -80
  40. package/src/analyzers/security-analyzer.js +19 -11
  41. package/src/analyzers/stuck-detector.js +19 -17
  42. package/src/converters/index.js +78 -57
  43. package/src/converters/ir/types.js +12 -12
  44. package/src/converters/parsers/musubi-parser.js +134 -126
  45. package/src/converters/parsers/openapi-parser.js +70 -53
  46. package/src/converters/parsers/speckit-parser.js +239 -175
  47. package/src/converters/writers/musubi-writer.js +123 -118
  48. package/src/converters/writers/speckit-writer.js +124 -113
  49. package/src/generators/rust-migration-generator.js +512 -0
  50. package/src/gui/public/index.html +1365 -1211
  51. package/src/gui/server.js +41 -40
  52. package/src/gui/services/file-watcher.js +23 -8
  53. package/src/gui/services/project-scanner.js +26 -20
  54. package/src/gui/services/replanning-service.js +27 -23
  55. package/src/gui/services/traceability-service.js +8 -8
  56. package/src/gui/services/workflow-service.js +14 -7
  57. package/src/index.js +151 -0
  58. package/src/integrations/cicd.js +90 -104
  59. package/src/integrations/codegraph-mcp.js +643 -0
  60. package/src/integrations/documentation.js +142 -103
  61. package/src/integrations/examples.js +95 -80
  62. package/src/integrations/github-client.js +17 -17
  63. package/src/integrations/index.js +5 -5
  64. package/src/integrations/mcp/index.js +21 -21
  65. package/src/integrations/mcp/mcp-context-provider.js +76 -78
  66. package/src/integrations/mcp/mcp-discovery.js +74 -72
  67. package/src/integrations/mcp/mcp-tool-registry.js +99 -94
  68. package/src/integrations/mcp-connector.js +70 -66
  69. package/src/integrations/platforms.js +50 -49
  70. package/src/integrations/tool-discovery.js +37 -31
  71. package/src/llm-providers/anthropic-provider.js +11 -11
  72. package/src/llm-providers/base-provider.js +16 -18
  73. package/src/llm-providers/copilot-provider.js +22 -19
  74. package/src/llm-providers/index.js +26 -25
  75. package/src/llm-providers/ollama-provider.js +11 -11
  76. package/src/llm-providers/openai-provider.js +12 -12
  77. package/src/managers/agent-memory.js +36 -24
  78. package/src/managers/checkpoint-manager.js +4 -8
  79. package/src/managers/delta-spec.js +19 -19
  80. package/src/managers/index.js +13 -4
  81. package/src/managers/memory-condenser.js +35 -45
  82. package/src/managers/repo-skill-manager.js +57 -31
  83. package/src/managers/skill-loader.js +25 -22
  84. package/src/managers/skill-tools.js +36 -72
  85. package/src/managers/workflow.js +30 -22
  86. package/src/monitoring/cost-tracker.js +53 -44
  87. package/src/monitoring/incident-manager.js +123 -103
  88. package/src/monitoring/index.js +144 -134
  89. package/src/monitoring/observability.js +82 -59
  90. package/src/monitoring/quality-dashboard.js +51 -39
  91. package/src/monitoring/release-manager.js +70 -50
  92. package/src/orchestration/agent-skill-binding.js +39 -47
  93. package/src/orchestration/error-handler.js +65 -107
  94. package/src/orchestration/guardrails/base-guardrail.js +26 -24
  95. package/src/orchestration/guardrails/guardrail-rules.js +50 -64
  96. package/src/orchestration/guardrails/index.js +5 -5
  97. package/src/orchestration/guardrails/input-guardrail.js +58 -45
  98. package/src/orchestration/guardrails/output-guardrail.js +104 -81
  99. package/src/orchestration/guardrails/safety-check.js +79 -79
  100. package/src/orchestration/index.js +38 -55
  101. package/src/orchestration/mcp-tool-adapters.js +96 -99
  102. package/src/orchestration/orchestration-engine.js +21 -21
  103. package/src/orchestration/pattern-registry.js +60 -45
  104. package/src/orchestration/patterns/auto.js +34 -47
  105. package/src/orchestration/patterns/group-chat.js +59 -65
  106. package/src/orchestration/patterns/handoff.js +67 -65
  107. package/src/orchestration/patterns/human-in-loop.js +51 -72
  108. package/src/orchestration/patterns/nested.js +25 -40
  109. package/src/orchestration/patterns/sequential.js +35 -34
  110. package/src/orchestration/patterns/swarm.js +63 -56
  111. package/src/orchestration/patterns/triage.js +150 -109
  112. package/src/orchestration/reasoning/index.js +9 -9
  113. package/src/orchestration/reasoning/planning-engine.js +143 -140
  114. package/src/orchestration/reasoning/reasoning-engine.js +206 -144
  115. package/src/orchestration/reasoning/self-correction.js +121 -128
  116. package/src/orchestration/replanning/adaptive-goal-modifier.js +107 -112
  117. package/src/orchestration/replanning/alternative-generator.js +37 -42
  118. package/src/orchestration/replanning/config.js +63 -59
  119. package/src/orchestration/replanning/goal-progress-tracker.js +98 -100
  120. package/src/orchestration/replanning/index.js +24 -20
  121. package/src/orchestration/replanning/plan-evaluator.js +49 -50
  122. package/src/orchestration/replanning/plan-monitor.js +32 -28
  123. package/src/orchestration/replanning/proactive-path-optimizer.js +175 -178
  124. package/src/orchestration/replanning/replan-history.js +33 -26
  125. package/src/orchestration/replanning/replanning-engine.js +106 -108
  126. package/src/orchestration/skill-executor.js +107 -109
  127. package/src/orchestration/skill-registry.js +85 -89
  128. package/src/orchestration/workflow-examples.js +228 -231
  129. package/src/orchestration/workflow-executor.js +65 -68
  130. package/src/orchestration/workflow-orchestrator.js +72 -73
  131. package/src/phase4-integration.js +47 -40
  132. package/src/phase5-integration.js +89 -30
  133. package/src/reporters/coverage-report.js +82 -30
  134. package/src/reporters/hierarchical-reporter.js +498 -0
  135. package/src/reporters/traceability-matrix-report.js +29 -20
  136. package/src/resolvers/issue-resolver.js +43 -31
  137. package/src/steering/advanced-validation.js +133 -124
  138. package/src/steering/auto-updater.js +60 -73
  139. package/src/steering/index.js +6 -6
  140. package/src/steering/quality-metrics.js +41 -35
  141. package/src/steering/steering-auto-update.js +83 -86
  142. package/src/steering/steering-validator.js +98 -106
  143. package/src/steering/template-constraints.js +53 -54
  144. package/src/templates/agents/claude-code/CLAUDE.md +32 -32
  145. package/src/templates/agents/claude-code/skills/agent-assistant/SKILL.md +13 -5
  146. package/src/templates/agents/claude-code/skills/ai-ml-engineer/mlops-guide.md +23 -23
  147. package/src/templates/agents/claude-code/skills/ai-ml-engineer/model-card-template.md +60 -41
  148. package/src/templates/agents/claude-code/skills/api-designer/api-patterns.md +27 -19
  149. package/src/templates/agents/claude-code/skills/api-designer/openapi-template.md +11 -7
  150. package/src/templates/agents/claude-code/skills/bug-hunter/SKILL.md +4 -3
  151. package/src/templates/agents/claude-code/skills/bug-hunter/root-cause-analysis.md +37 -15
  152. package/src/templates/agents/claude-code/skills/change-impact-analyzer/dependency-graph-patterns.md +36 -42
  153. package/src/templates/agents/claude-code/skills/change-impact-analyzer/impact-analysis-template.md +69 -60
  154. package/src/templates/agents/claude-code/skills/cloud-architect/aws-patterns.md +31 -38
  155. package/src/templates/agents/claude-code/skills/cloud-architect/azure-patterns.md +28 -23
  156. package/src/templates/agents/claude-code/skills/code-reviewer/SKILL.md +61 -0
  157. package/src/templates/agents/claude-code/skills/code-reviewer/best-practices.md +27 -0
  158. package/src/templates/agents/claude-code/skills/code-reviewer/review-checklist.md +29 -10
  159. package/src/templates/agents/claude-code/skills/code-reviewer/review-standards.md +29 -24
  160. package/src/templates/agents/claude-code/skills/constitution-enforcer/SKILL.md +8 -6
  161. package/src/templates/agents/claude-code/skills/constitution-enforcer/constitutional-articles.md +62 -26
  162. package/src/templates/agents/claude-code/skills/constitution-enforcer/phase-minus-one-gates.md +35 -16
  163. package/src/templates/agents/claude-code/skills/database-administrator/backup-recovery.md +27 -17
  164. package/src/templates/agents/claude-code/skills/database-administrator/tuning-guide.md +25 -20
  165. package/src/templates/agents/claude-code/skills/database-schema-designer/schema-patterns.md +39 -22
  166. package/src/templates/agents/claude-code/skills/devops-engineer/ci-cd-templates.md +25 -22
  167. package/src/templates/agents/claude-code/skills/issue-resolver/SKILL.md +24 -21
  168. package/src/templates/agents/claude-code/skills/orchestrator/SKILL.md +148 -63
  169. package/src/templates/agents/claude-code/skills/orchestrator/patterns.md +35 -16
  170. package/src/templates/agents/claude-code/skills/orchestrator/selection-matrix.md +69 -64
  171. package/src/templates/agents/claude-code/skills/performance-engineer/optimization-playbook.md +47 -47
  172. package/src/templates/agents/claude-code/skills/performance-optimizer/SKILL.md +69 -0
  173. package/src/templates/agents/claude-code/skills/performance-optimizer/benchmark-template.md +63 -45
  174. package/src/templates/agents/claude-code/skills/performance-optimizer/optimization-patterns.md +33 -35
  175. package/src/templates/agents/claude-code/skills/project-manager/SKILL.md +7 -6
  176. package/src/templates/agents/claude-code/skills/project-manager/agile-ceremonies.md +47 -28
  177. package/src/templates/agents/claude-code/skills/project-manager/project-templates.md +94 -78
  178. package/src/templates/agents/claude-code/skills/quality-assurance/SKILL.md +20 -17
  179. package/src/templates/agents/claude-code/skills/quality-assurance/qa-plan-template.md +63 -49
  180. package/src/templates/agents/claude-code/skills/release-coordinator/SKILL.md +5 -5
  181. package/src/templates/agents/claude-code/skills/release-coordinator/feature-flag-guide.md +30 -26
  182. package/src/templates/agents/claude-code/skills/release-coordinator/release-plan-template.md +67 -35
  183. package/src/templates/agents/claude-code/skills/requirements-analyst/ears-format.md +54 -42
  184. package/src/templates/agents/claude-code/skills/requirements-analyst/validation-rules.md +36 -33
  185. package/src/templates/agents/claude-code/skills/security-auditor/SKILL.md +77 -19
  186. package/src/templates/agents/claude-code/skills/security-auditor/audit-checklists.md +24 -24
  187. package/src/templates/agents/claude-code/skills/security-auditor/owasp-top-10.md +61 -20
  188. package/src/templates/agents/claude-code/skills/security-auditor/vulnerability-patterns.md +43 -11
  189. package/src/templates/agents/claude-code/skills/site-reliability-engineer/SKILL.md +1 -0
  190. package/src/templates/agents/claude-code/skills/site-reliability-engineer/incident-response-template.md +55 -25
  191. package/src/templates/agents/claude-code/skills/site-reliability-engineer/observability-patterns.md +78 -68
  192. package/src/templates/agents/claude-code/skills/site-reliability-engineer/slo-sli-guide.md +73 -53
  193. package/src/templates/agents/claude-code/skills/software-developer/solid-principles.md +83 -37
  194. package/src/templates/agents/claude-code/skills/software-developer/test-first-workflow.md +38 -31
  195. package/src/templates/agents/claude-code/skills/steering/SKILL.md +1 -0
  196. package/src/templates/agents/claude-code/skills/steering/auto-update-rules.md +31 -0
  197. package/src/templates/agents/claude-code/skills/system-architect/adr-template.md +25 -7
  198. package/src/templates/agents/claude-code/skills/system-architect/c4-model-guide.md +74 -61
  199. package/src/templates/agents/claude-code/skills/technical-writer/doc-templates/documentation-templates.md +70 -52
  200. package/src/templates/agents/claude-code/skills/test-engineer/SKILL.md +2 -0
  201. package/src/templates/agents/claude-code/skills/test-engineer/ears-test-mapping.md +75 -71
  202. package/src/templates/agents/claude-code/skills/test-engineer/test-types.md +85 -63
  203. package/src/templates/agents/claude-code/skills/traceability-auditor/coverage-matrix-template.md +39 -36
  204. package/src/templates/agents/claude-code/skills/traceability-auditor/gap-detection-rules.md +22 -17
  205. package/src/templates/agents/claude-code/skills/ui-ux-designer/SKILL.md +1 -0
  206. package/src/templates/agents/claude-code/skills/ui-ux-designer/accessibility-guidelines.md +49 -75
  207. package/src/templates/agents/claude-code/skills/ui-ux-designer/design-system-components.md +71 -59
  208. package/src/templates/agents/codex/AGENTS.md +74 -42
  209. package/src/templates/agents/cursor/AGENTS.md +74 -42
  210. package/src/templates/agents/gemini-cli/GEMINI.md +74 -42
  211. package/src/templates/agents/github-copilot/AGENTS.md +83 -51
  212. package/src/templates/agents/qwen-code/QWEN.md +74 -42
  213. package/src/templates/agents/windsurf/AGENTS.md +74 -42
  214. package/src/templates/architectures/README.md +41 -0
  215. package/src/templates/architectures/clean-architecture/README.md +113 -0
  216. package/src/templates/architectures/event-driven/README.md +162 -0
  217. package/src/templates/architectures/hexagonal/README.md +130 -0
  218. package/src/templates/index.js +6 -1
  219. package/src/templates/locale-manager.js +16 -16
  220. package/src/templates/shared/delta-spec-template.md +20 -13
  221. package/src/templates/shared/github-actions/musubi-issue-resolver.yml +5 -5
  222. package/src/templates/shared/github-actions/musubi-security-check.yml +3 -3
  223. package/src/templates/shared/github-actions/musubi-validate.yml +4 -4
  224. package/src/templates/shared/steering/structure.md +95 -0
  225. package/src/templates/skills/browser-agent.md +21 -16
  226. package/src/templates/skills/web-gui.md +8 -0
  227. package/src/templates/template-constraints.js +50 -53
  228. package/src/validators/advanced-validation.js +30 -36
  229. package/src/validators/constitutional-validator.js +77 -73
  230. package/src/validators/critic-system.js +49 -59
  231. package/src/validators/delta-format.js +59 -55
  232. package/src/validators/traceability-validator.js +7 -11
@@ -14,19 +14,22 @@ Template for documenting machine learning models following best practices.
14
14
  ## Model Details
15
15
 
16
16
  ### Basic Information
17
- | Field | Value |
18
- |-------|-------|
19
- | Model Name | [Name] |
20
- | Version | [X.Y.Z] |
21
- | Type | [Classification/Regression/etc.] |
22
- | Framework | [TensorFlow/PyTorch/scikit-learn] |
23
- | Date | YYYY-MM-DD |
24
- | Authors | [Team/Names] |
17
+
18
+ | Field | Value |
19
+ | ---------- | --------------------------------- |
20
+ | Model Name | [Name] |
21
+ | Version | [X.Y.Z] |
22
+ | Type | [Classification/Regression/etc.] |
23
+ | Framework | [TensorFlow/PyTorch/scikit-learn] |
24
+ | Date | YYYY-MM-DD |
25
+ | Authors | [Team/Names] |
25
26
 
26
27
  ### Description
28
+
27
29
  [Brief description of what the model does]
28
30
 
29
31
  ### Intended Use
32
+
30
33
  - **Primary Use Cases**: [What it's designed for]
31
34
  - **Intended Users**: [Who should use it]
32
35
  - **Out-of-Scope Uses**: [What it shouldn't be used for]
@@ -36,75 +39,87 @@ Template for documenting machine learning models following best practices.
36
39
  ## Model Architecture
37
40
 
38
41
  ### Overview
42
+
39
43
  [Description of model architecture]
40
44
 
41
45
  ### Inputs
42
- | Name | Type | Shape | Description |
43
- |------|------|-------|-------------|
44
- | feature_1 | float | (1,) | Transaction amount |
45
- | feature_2 | int | (1,) | Category code |
46
+
47
+ | Name | Type | Shape | Description |
48
+ | --------- | ----- | ----- | ------------------ |
49
+ | feature_1 | float | (1,) | Transaction amount |
50
+ | feature_2 | int | (1,) | Category code |
46
51
 
47
52
  ### Outputs
48
- | Name | Type | Shape | Description |
49
- |------|------|-------|-------------|
50
- | prediction | int | (1,) | Class label |
53
+
54
+ | Name | Type | Shape | Description |
55
+ | ----------- | ----- | ------------ | ------------------- |
56
+ | prediction | int | (1,) | Class label |
51
57
  | probability | float | (n_classes,) | Class probabilities |
52
58
 
53
59
  ### Hyperparameters
54
- | Parameter | Value |
55
- |-----------|-------|
60
+
61
+ | Parameter | Value |
62
+ | ------------- | ----- |
56
63
  | learning_rate | 0.001 |
57
- | batch_size | 32 |
58
- | epochs | 100 |
64
+ | batch_size | 32 |
65
+ | epochs | 100 |
59
66
 
60
67
  ---
61
68
 
62
69
  ## Training Data
63
70
 
64
71
  ### Dataset Description
65
- | Field | Value |
66
- |-------|-------|
67
- | Name | [Dataset name] |
68
- | Version | [Version] |
69
- | Size | [N samples] |
72
+
73
+ | Field | Value |
74
+ | ---------- | ---------------- |
75
+ | Name | [Dataset name] |
76
+ | Version | [Version] |
77
+ | Size | [N samples] |
70
78
  | Date Range | [Start] to [End] |
71
79
 
72
80
  ### Data Distribution
81
+
73
82
  | Feature | Distribution |
74
- |---------|--------------|
75
- | Class 0 | 85% |
76
- | Class 1 | 15% |
83
+ | ------- | ------------ |
84
+ | Class 0 | 85% |
85
+ | Class 1 | 15% |
77
86
 
78
87
  ### Preprocessing
88
+
79
89
  - [Step 1]: [Description]
80
90
  - [Step 2]: [Description]
81
91
 
82
92
  ### Data Splits
83
- | Split | Size | Purpose |
84
- |-------|------|---------|
85
- | Train | 70% | Model training |
86
- | Validation | 15% | Hyperparameter tuning |
87
- | Test | 15% | Final evaluation |
93
+
94
+ | Split | Size | Purpose |
95
+ | ---------- | ---- | --------------------- |
96
+ | Train | 70% | Model training |
97
+ | Validation | 15% | Hyperparameter tuning |
98
+ | Test | 15% | Final evaluation |
88
99
 
89
100
  ---
90
101
 
91
102
  ## Evaluation
92
103
 
93
104
  ### Metrics
94
- | Metric | Value | Threshold |
95
- |--------|-------|-----------|
96
- | Accuracy | 0.95 | > 0.90 |
97
- | Precision | 0.92 | > 0.85 |
98
- | Recall | 0.88 | > 0.80 |
99
- | F1 Score | 0.90 | > 0.85 |
100
- | AUC-ROC | 0.97 | > 0.90 |
105
+
106
+ | Metric | Value | Threshold |
107
+ | --------- | ----- | --------- |
108
+ | Accuracy | 0.95 | > 0.90 |
109
+ | Precision | 0.92 | > 0.85 |
110
+ | Recall | 0.88 | > 0.80 |
111
+ | F1 Score | 0.90 | > 0.85 |
112
+ | AUC-ROC | 0.97 | > 0.90 |
101
113
 
102
114
  ### Confusion Matrix
103
115
  ```
116
+
104
117
  Predicted
105
118
  0 1
106
- Actual 0 850 50
107
- 1 30 120
119
+
120
+ Actual 0 850 50
121
+ 1 30 120
122
+
108
123
  ```
109
124
 
110
125
  ### Performance by Subgroup
@@ -149,9 +164,11 @@ Actual 0 850 50
149
164
 
150
165
  ### Requirements
151
166
  ```
167
+
152
168
  python>=3.9
153
169
  tensorflow==2.12.0
154
170
  numpy==1.24.0
171
+
155
172
  ```
156
173
 
157
174
  ### Resource Requirements
@@ -229,6 +246,7 @@ For questions or issues:
229
246
  ## Quick Checklist
230
247
 
231
248
  ### Before Release
249
+
232
250
  - [ ] Model architecture documented
233
251
  - [ ] Training data described
234
252
  - [ ] Evaluation metrics included
@@ -239,6 +257,7 @@ For questions or issues:
239
257
  - [ ] Version history updated
240
258
 
241
259
  ### Review Questions
260
+
242
261
  1. Is the intended use clearly defined?
243
262
  2. Are limitations and risks documented?
244
263
  3. Can another team reproduce training?
@@ -24,28 +24,28 @@ POST /createOrder
24
24
 
25
25
  ### HTTP Methods
26
26
 
27
- | Method | Action | Idempotent | Safe |
28
- |--------|--------|------------|------|
29
- | GET | Read | Yes | Yes |
30
- | POST | Create | No | No |
31
- | PUT | Replace | Yes | No |
32
- | PATCH | Update | Yes | No |
33
- | DELETE | Remove | Yes | No |
27
+ | Method | Action | Idempotent | Safe |
28
+ | ------ | ------- | ---------- | ---- |
29
+ | GET | Read | Yes | Yes |
30
+ | POST | Create | No | No |
31
+ | PUT | Replace | Yes | No |
32
+ | PATCH | Update | Yes | No |
33
+ | DELETE | Remove | Yes | No |
34
34
 
35
35
  ### Status Codes
36
36
 
37
- | Code | Meaning | Use Case |
38
- |------|---------|----------|
39
- | 200 | OK | Successful GET, PUT, PATCH |
40
- | 201 | Created | Successful POST |
41
- | 204 | No Content | Successful DELETE |
42
- | 400 | Bad Request | Invalid input |
43
- | 401 | Unauthorized | Missing auth |
44
- | 403 | Forbidden | No permission |
45
- | 404 | Not Found | Resource doesn't exist |
46
- | 409 | Conflict | Resource conflict |
47
- | 422 | Unprocessable | Validation error |
48
- | 500 | Server Error | Unexpected error |
37
+ | Code | Meaning | Use Case |
38
+ | ---- | ------------- | -------------------------- |
39
+ | 200 | OK | Successful GET, PUT, PATCH |
40
+ | 201 | Created | Successful POST |
41
+ | 204 | No Content | Successful DELETE |
42
+ | 400 | Bad Request | Invalid input |
43
+ | 401 | Unauthorized | Missing auth |
44
+ | 403 | Forbidden | No permission |
45
+ | 404 | Not Found | Resource doesn't exist |
46
+ | 409 | Conflict | Resource conflict |
47
+ | 422 | Unprocessable | Validation error |
48
+ | 500 | Server Error | Unexpected error |
49
49
 
50
50
  ---
51
51
 
@@ -192,18 +192,21 @@ GET /users?fields=id,name,email
192
192
  ## Versioning
193
193
 
194
194
  ### URL Versioning
195
+
195
196
  ```
196
197
  GET /v1/users
197
198
  GET /v2/users
198
199
  ```
199
200
 
200
201
  ### Header Versioning
202
+
201
203
  ```
202
204
  GET /users
203
205
  Accept: application/vnd.api.v1+json
204
206
  ```
205
207
 
206
208
  ### Query Parameter
209
+
207
210
  ```
208
211
  GET /users?version=1
209
212
  ```
@@ -309,28 +312,33 @@ components:
309
312
  ## Design Checklist
310
313
 
311
314
  ### Naming
315
+
312
316
  - [ ] Resources are nouns
313
317
  - [ ] Plural names for collections
314
318
  - [ ] Lowercase with hyphens
315
319
  - [ ] Consistent naming
316
320
 
317
321
  ### Methods
322
+
318
323
  - [ ] Correct HTTP methods
319
324
  - [ ] Idempotency maintained
320
325
  - [ ] Proper status codes
321
326
 
322
327
  ### Responses
328
+
323
329
  - [ ] Consistent format
324
330
  - [ ] Useful error messages
325
331
  - [ ] Pagination for lists
326
332
 
327
333
  ### Security
334
+
328
335
  - [ ] Authentication required
329
336
  - [ ] Rate limiting enabled
330
337
  - [ ] Input validation
331
338
  - [ ] CORS configured
332
339
 
333
340
  ### Documentation
341
+
334
342
  - [ ] OpenAPI spec available
335
343
  - [ ] Examples included
336
344
  - [ ] Error codes documented
@@ -65,7 +65,7 @@ paths:
65
65
  $ref: '#/components/responses/InternalError'
66
66
  security:
67
67
  - bearerAuth: []
68
-
68
+
69
69
  post:
70
70
  tags:
71
71
  - Users
@@ -272,7 +272,7 @@ components:
272
272
  schema:
273
273
  type: string
274
274
  format: uuid
275
-
275
+
276
276
  PageParam:
277
277
  name: page
278
278
  in: query
@@ -281,7 +281,7 @@ components:
281
281
  type: integer
282
282
  minimum: 1
283
283
  default: 1
284
-
284
+
285
285
  LimitParam:
286
286
  name: limit
287
287
  in: query
@@ -302,7 +302,7 @@ components:
302
302
  example:
303
303
  code: VALIDATION_ERROR
304
304
  message: Invalid request data
305
-
305
+
306
306
  Unauthorized:
307
307
  description: Unauthorized
308
308
  content:
@@ -312,7 +312,7 @@ components:
312
312
  example:
313
313
  code: UNAUTHORIZED
314
314
  message: Authentication required
315
-
315
+
316
316
  NotFound:
317
317
  description: Resource not found
318
318
  content:
@@ -322,7 +322,7 @@ components:
322
322
  example:
323
323
  code: NOT_FOUND
324
324
  message: Resource not found
325
-
325
+
326
326
  InternalError:
327
327
  description: Internal server error
328
328
  content:
@@ -338,7 +338,7 @@ components:
338
338
  type: http
339
339
  scheme: bearer
340
340
  bearerFormat: JWT
341
-
341
+
342
342
  apiKey:
343
343
  type: apiKey
344
344
  in: header
@@ -353,11 +353,13 @@ security:
353
353
  ## OpenAPI Checklist
354
354
 
355
355
  ### Info
356
+
356
357
  - [ ] Title and description
357
358
  - [ ] Version number
358
359
  - [ ] Contact information
359
360
 
360
361
  ### Paths
362
+
361
363
  - [ ] All endpoints documented
362
364
  - [ ] HTTP methods specified
363
365
  - [ ] Parameters defined
@@ -365,12 +367,14 @@ security:
365
367
  - [ ] Response codes listed
366
368
 
367
369
  ### Components
370
+
368
371
  - [ ] Schemas for all models
369
372
  - [ ] Reusable parameters
370
373
  - [ ] Common responses
371
374
  - [ ] Security schemes
372
375
 
373
376
  ### Examples
377
+
374
378
  - [ ] Request examples
375
379
  - [ ] Response examples
376
380
  - [ ] Error examples
@@ -39,7 +39,7 @@ const { StuckDetector } = require('musubi/src/analyzers/stuck-detector');
39
39
 
40
40
  const detector = new StuckDetector({
41
41
  repeatThreshold: 3,
42
- minHistoryLength: 5
42
+ minHistoryLength: 5,
43
43
  });
44
44
 
45
45
  // Monitor debugging actions
@@ -64,7 +64,7 @@ const issue = new IssueInfo({
64
64
  number: 42,
65
65
  title: 'App crashes on login',
66
66
  body: '## Steps to reproduce\n1. Click login\n2. App crashes',
67
- labels: ['bug', 'critical']
67
+ labels: ['bug', 'critical'],
68
68
  });
69
69
 
70
70
  const resolver = new IssueResolver();
@@ -83,7 +83,8 @@ const analyzer = new SecurityAnalyzer();
83
83
  const result = analyzer.analyzeContent(code, 'vulnerable.js');
84
84
 
85
85
  // Check for security vulnerabilities
86
- result.risks.filter(r => r.category === 'vulnerability')
86
+ result.risks
87
+ .filter(r => r.category === 'vulnerability')
87
88
  .forEach(risk => console.log(risk.pattern, risk.severity));
88
89
  ```
89
90
 
@@ -32,17 +32,20 @@ Ask "Why?" five times to get to the root cause.
32
32
 
33
33
  ```markdown
34
34
  ## Reproduction Steps
35
+
35
36
  1. [Step to reproduce]
36
37
  2. [Step to reproduce]
37
38
  3. [Observe behavior]
38
39
 
39
40
  ## Environment
41
+
40
42
  - OS: [OS version]
41
- - Browser: [Browser version]
43
+ - Browser: [Browser version]
42
44
  - Version: [App version]
43
45
  - User role: [Role]
44
46
 
45
47
  ## Expected vs Actual
48
+
46
49
  - Expected: [Expected behavior]
47
50
  - Actual: [Actual behavior]
48
51
  ```
@@ -51,15 +54,18 @@ Ask "Why?" five times to get to the root cause.
51
54
 
52
55
  ```markdown
53
56
  ## Error Information
57
+
54
58
  - Error message: [message]
55
59
  - Stack trace: [trace]
56
60
  - Error code: [code]
57
61
 
58
62
  ## Logs
63
+
59
64
  - Timestamp: [time]
60
65
  - Relevant logs: [logs]
61
66
 
62
67
  ## Metrics
68
+
63
69
  - CPU/Memory: [values]
64
70
  - Request rate: [rate]
65
71
  - Error rate: [rate]
@@ -78,16 +84,20 @@ Ask "Why?" five times to get to the root cause.
78
84
  ## Root Cause Analysis
79
85
 
80
86
  ### Direct Cause
87
+
81
88
  [What directly caused the symptom]
82
89
 
83
90
  ### Contributing Factors
91
+
84
92
  - [Factor 1]
85
93
  - [Factor 2]
86
94
 
87
95
  ### Root Cause
96
+
88
97
  [The underlying issue that should be fixed]
89
98
 
90
99
  ### Evidence
100
+
91
101
  [How we know this is the root cause]
92
102
  ```
93
103
 
@@ -97,12 +107,15 @@ Ask "Why?" five times to get to the root cause.
97
107
  ## Resolution
98
108
 
99
109
  ### Immediate Fix
110
+
100
111
  [What was done to resolve the issue]
101
112
 
102
113
  ### Prevention
114
+
103
115
  [What will prevent recurrence]
104
116
 
105
117
  ### Verification
118
+
106
119
  [How we verified the fix works]
107
120
  ```
108
121
 
@@ -114,37 +127,46 @@ Ask "Why?" five times to get to the root cause.
114
127
  # Bug Report: [Title]
115
128
 
116
129
  ## Summary
130
+
117
131
  [Brief description]
118
132
 
119
133
  ## Severity
134
+
120
135
  - [ ] Critical (system down)
121
136
  - [ ] High (major feature broken)
122
137
  - [ ] Medium (feature degraded)
123
138
  - [ ] Low (minor issue)
124
139
 
125
140
  ## Steps to Reproduce
126
- 1.
127
- 2.
128
- 3.
141
+
142
+ 1.
143
+ 2.
144
+ 3.
129
145
 
130
146
  ## Expected Behavior
147
+
131
148
  [What should happen]
132
149
 
133
150
  ## Actual Behavior
151
+
134
152
  [What actually happens]
135
153
 
136
154
  ## Environment
137
- - Version:
138
- - Browser:
139
- - OS:
155
+
156
+ - Version:
157
+ - Browser:
158
+ - OS:
140
159
 
141
160
  ## Logs/Screenshots
161
+
142
162
  [Attach relevant evidence]
143
163
 
144
164
  ## Root Cause (after investigation)
165
+
145
166
  [The identified root cause]
146
167
 
147
168
  ## Fix
169
+
148
170
  [The solution implemented]
149
171
  ```
150
172
 
@@ -152,14 +174,14 @@ Ask "Why?" five times to get to the root cause.
152
174
 
153
175
  ## Common Bug Categories
154
176
 
155
- | Category | Symptoms | Typical Causes |
156
- |----------|----------|----------------|
157
- | Logic Error | Wrong output | Incorrect algorithm, edge case |
158
- | Null Reference | Crash | Missing null check |
159
- | Race Condition | Intermittent | Concurrency issue |
160
- | Memory Leak | Slow degradation | Uncleaned resources |
161
- | Timeout | Slow/hang | Network, long query |
162
- | Security | Unauthorized access | Missing validation |
177
+ | Category | Symptoms | Typical Causes |
178
+ | -------------- | ------------------- | ------------------------------ |
179
+ | Logic Error | Wrong output | Incorrect algorithm, edge case |
180
+ | Null Reference | Crash | Missing null check |
181
+ | Race Condition | Intermittent | Concurrency issue |
182
+ | Memory Leak | Slow degradation | Uncleaned resources |
183
+ | Timeout | Slow/hang | Network, long query |
184
+ | Security | Unauthorized access | Missing validation |
163
185
 
164
186
  ---
165
187