bmad-method 6.0.0-Beta.7 → 6.0.0-Beta.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.
- package/.augment/code_review_guidelines.yaml +271 -0
- package/.coderabbit.yaml +56 -11
- package/.github/PULL_REQUEST_TEMPLATE.md +13 -0
- package/.github/workflows/coderabbit-review.yaml +22 -0
- package/.github/workflows/docs.yaml +4 -3
- package/.github/workflows/quality.yaml +1 -3
- package/CHANGELOG.md +53 -0
- package/CONTRIBUTING.md +9 -0
- package/README.md +8 -0
- package/docs/404.md +1 -1
- package/docs/_STYLE_GUIDE.md +3 -2
- package/docs/explanation/advanced-elicitation.md +26 -1
- package/docs/explanation/adversarial-review.md +3 -1
- package/docs/explanation/brainstorming.md +2 -0
- package/docs/explanation/established-projects-faq.md +50 -0
- package/docs/explanation/party-mode.md +2 -0
- package/docs/explanation/preventing-agent-conflicts.md +3 -1
- package/docs/explanation/quick-flow.md +60 -14
- package/docs/explanation/why-solutioning-matters.md +4 -2
- package/docs/how-to/customize-bmad.md +72 -58
- package/docs/how-to/{brownfield/index.md → established-projects.md} +9 -11
- package/docs/how-to/get-answers-about-bmad.md +3 -2
- package/docs/how-to/install-bmad.md +16 -10
- package/docs/how-to/non-interactive-installation.md +171 -0
- package/docs/how-to/quick-fixes.md +123 -0
- package/docs/how-to/shard-large-documents.md +13 -36
- package/docs/how-to/upgrade-to-v6.md +28 -62
- package/docs/index.md +6 -12
- package/docs/reference/agents.md +9 -3
- package/docs/reference/commands.md +116 -19
- package/docs/reference/modules.md +76 -0
- package/docs/reference/testing.md +94 -9
- package/docs/reference/workflow-map.md +9 -5
- package/docs/tutorials/getting-started.md +2 -2
- package/eslint.config.mjs +5 -16
- package/package.json +4 -15
- package/src/bmm/module.yaml +6 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +1 -1
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +1 -1
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +28 -34
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +3 -3
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +1 -1
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +1 -7
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +0 -6
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +0 -6
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +0 -6
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +0 -7
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +1 -7
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +1 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +0 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +0 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +0 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +0 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +1 -3
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +0 -3
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +1 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +0 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +0 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +1 -2
- package/src/core/tasks/help.md +9 -6
- package/src/core/workflows/party-mode/steps/step-03-graceful-exit.md +11 -0
- package/test/fixtures/file-refs-csv/invalid/all-empty-workflow.csv +3 -0
- package/test/fixtures/file-refs-csv/invalid/empty-data.csv +1 -0
- package/test/fixtures/file-refs-csv/invalid/no-workflow-column.csv +3 -0
- package/test/fixtures/file-refs-csv/invalid/unresolvable-vars.csv +3 -0
- package/test/fixtures/file-refs-csv/valid/bmm-style.csv +3 -0
- package/test/fixtures/file-refs-csv/valid/core-style.csv +3 -0
- package/test/fixtures/file-refs-csv/valid/minimal.csv +2 -0
- package/test/test-file-refs-csv.js +133 -0
- package/test/test-rehype-plugins.mjs +1050 -0
- package/tools/{build-docs.js → build-docs.mjs} +29 -163
- package/tools/cli/bmad-cli.js +19 -11
- package/tools/cli/commands/install.js +35 -19
- package/tools/cli/commands/status.js +9 -9
- package/tools/cli/external-official-modules.yaml +11 -12
- package/tools/cli/installers/lib/core/config-collector.js +67 -88
- package/tools/cli/installers/lib/core/dependency-resolver.js +20 -16
- package/tools/cli/installers/lib/core/installer.js +241 -233
- package/tools/cli/installers/lib/custom/handler.js +10 -15
- package/tools/cli/installers/lib/ide/_base-ide.js +3 -3
- package/tools/cli/installers/lib/ide/_config-driven.js +21 -28
- package/tools/cli/installers/lib/ide/codex.js +37 -63
- package/tools/cli/installers/lib/ide/kilo.js +134 -115
- package/tools/cli/installers/lib/ide/manager.js +44 -16
- package/tools/cli/installers/lib/ide/platform-codes.yaml +14 -7
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +0 -1
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +4 -5
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +10 -11
- package/tools/cli/installers/lib/ide/templates/{split/opencode/body.md → combined/kiro-agent.md} +7 -1
- package/tools/cli/installers/lib/ide/templates/combined/kiro-task.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-tool.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-workflow-yaml.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-workflow.md +7 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-agent.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-task.md +12 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-tool.md +12 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-workflow-yaml.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-workflow.md +15 -0
- package/tools/cli/installers/lib/ide/templates/split/.gitkeep +0 -0
- package/tools/cli/installers/lib/message-loader.js +5 -7
- package/tools/cli/installers/lib/modules/manager.js +172 -121
- package/tools/cli/lib/agent/installer.js +19 -55
- package/tools/cli/lib/cli-utils.js +55 -100
- package/tools/cli/lib/prompts.js +221 -31
- package/tools/cli/lib/ui.js +484 -369
- package/tools/docs/_prompt-external-modules-page.md +59 -0
- package/tools/fix-doc-links.js +4 -7
- package/tools/platform-codes.yaml +4 -4
- package/tools/validate-doc-links.js +29 -7
- package/tools/validate-file-refs.js +176 -102
- package/website/README.md +0 -1
- package/website/astro.config.mjs +1 -1
- package/website/src/components/Banner.astro +12 -9
- package/website/src/components/Header.astro +1 -26
- package/website/src/components/MobileMenuFooter.astro +0 -20
- package/website/{public/robots.txt → src/pages/robots.txt.ts} +14 -3
- package/website/src/rehype-base-paths.js +46 -23
- package/website/src/rehype-markdown-links.js +80 -86
- package/website/src/styles/custom.css +33 -24
- package/.claude/skills/changelog-social.skill +0 -0
- package/.github/workflows/manual-release.yaml +0 -193
- package/docs/bmgd/bmgd-logo.png +0 -0
- package/docs/bmgd/game-types.md +0 -375
- package/docs/bmgd/index.md +0 -113
- package/docs/bmgd/quick-flow-workflows.md +0 -161
- package/docs/bmgd/workflow.jpg +0 -0
- package/docs/downloads.md +0 -74
- package/docs/explanation/brownfield-faq.md +0 -55
- package/docs/how-to/brownfield/quick-fix-in-brownfield.md +0 -76
- package/src/bmm/_module-installer/installer.js +0 -48
- package/src/core/_module-installer/installer.js +0 -60
- package/tools/cli/installers/lib/ide/kiro-cli.js +0 -326
- package/tools/cli/installers/lib/ide/templates/split/opencode/header.md +0 -4
- package/tools/docs/BUNDLE_DISTRIBUTION_SETUP.md +0 -95
- package/tools/docs/index.md +0 -2
- package/website/_basement/components/WorkflowGuide.astro +0 -444
- package/website/_basement/pages/workflow-guide.astro +0 -17
- package/website/public/img/logo.svg +0 -4
- package/website/public/img/workflow-map.png +0 -0
- /package/website/src/lib/{site-url.js → site-url.mjs} +0 -0
|
@@ -0,0 +1,271 @@
|
|
|
1
|
+
# Augment Code Review Guidelines for BMAD-METHOD
|
|
2
|
+
# https://docs.augmentcode.com/codereview/overview
|
|
3
|
+
# Focus: Workflow validation and quality
|
|
4
|
+
|
|
5
|
+
file_paths_to_ignore:
|
|
6
|
+
# --- Shared baseline: tool configs ---
|
|
7
|
+
- ".coderabbit.yaml"
|
|
8
|
+
- ".augment/**"
|
|
9
|
+
- "eslint.config.mjs"
|
|
10
|
+
# --- Shared baseline: build output ---
|
|
11
|
+
- "dist/**"
|
|
12
|
+
- "build/**"
|
|
13
|
+
- "coverage/**"
|
|
14
|
+
# --- Shared baseline: vendored/generated ---
|
|
15
|
+
- "node_modules/**"
|
|
16
|
+
- "**/*.min.js"
|
|
17
|
+
- "**/*.generated.*"
|
|
18
|
+
- "**/*.bundle.md"
|
|
19
|
+
# --- Shared baseline: package metadata ---
|
|
20
|
+
- "package-lock.json"
|
|
21
|
+
# --- Shared baseline: binary/media ---
|
|
22
|
+
- "*.png"
|
|
23
|
+
- "*.jpg"
|
|
24
|
+
- "*.svg"
|
|
25
|
+
# --- Shared baseline: test fixtures ---
|
|
26
|
+
- "test/fixtures/**"
|
|
27
|
+
- "test/template-test-generator/**"
|
|
28
|
+
- "tools/template-test-generator/test-scenarios/**"
|
|
29
|
+
# --- Shared baseline: non-project dirs ---
|
|
30
|
+
- "_bmad*/**"
|
|
31
|
+
- "website/**"
|
|
32
|
+
- "z*/**"
|
|
33
|
+
- "sample-project/**"
|
|
34
|
+
- "test-project-install/**"
|
|
35
|
+
# --- Shared baseline: AI assistant dirs ---
|
|
36
|
+
- ".claude/**"
|
|
37
|
+
- ".codex/**"
|
|
38
|
+
- ".agent/**"
|
|
39
|
+
- ".agentvibes/**"
|
|
40
|
+
- ".kiro/**"
|
|
41
|
+
- ".roo/**"
|
|
42
|
+
- ".github/chatmodes/**"
|
|
43
|
+
# --- Shared baseline: build temp ---
|
|
44
|
+
- ".bundler-temp/**"
|
|
45
|
+
# --- Shared baseline: generated reports ---
|
|
46
|
+
- "**/validation-report-*.md"
|
|
47
|
+
- "CHANGELOG.md"
|
|
48
|
+
|
|
49
|
+
areas:
|
|
50
|
+
# ============================================
|
|
51
|
+
# WORKFLOW STRUCTURE RULES
|
|
52
|
+
# ============================================
|
|
53
|
+
workflow_structure:
|
|
54
|
+
description: "Workflow folder organization and required components"
|
|
55
|
+
globs:
|
|
56
|
+
- "src/**/workflows/**"
|
|
57
|
+
rules:
|
|
58
|
+
- id: "workflow_entry_point_required"
|
|
59
|
+
description: "Every workflow folder must have workflow.yaml, workflow.md, or workflow.xml as entry point"
|
|
60
|
+
severity: "high"
|
|
61
|
+
|
|
62
|
+
- id: "sharded_workflow_steps_folder"
|
|
63
|
+
description: "Sharded workflows (using workflow.md) must have steps/ folder with numbered files (step-01-*.md, step-02-*.md)"
|
|
64
|
+
severity: "high"
|
|
65
|
+
|
|
66
|
+
- id: "standard_workflow_instructions"
|
|
67
|
+
description: "Standard workflows using workflow.yaml must include instructions.md for execution guidance"
|
|
68
|
+
severity: "medium"
|
|
69
|
+
|
|
70
|
+
- id: "workflow_step_limit"
|
|
71
|
+
description: "Workflows should have 5-10 steps maximum to prevent context loss in LLM execution"
|
|
72
|
+
severity: "medium"
|
|
73
|
+
|
|
74
|
+
# ============================================
|
|
75
|
+
# WORKFLOW ENTRY FILE RULES
|
|
76
|
+
# ============================================
|
|
77
|
+
workflow_definitions:
|
|
78
|
+
description: "Workflow entry files (workflow.yaml, workflow.md, workflow.xml)"
|
|
79
|
+
globs:
|
|
80
|
+
- "src/**/workflows/**/workflow.yaml"
|
|
81
|
+
- "src/**/workflows/**/workflow.md"
|
|
82
|
+
- "src/**/workflows/**/workflow.xml"
|
|
83
|
+
rules:
|
|
84
|
+
- id: "workflow_name_required"
|
|
85
|
+
description: "Workflow entry files must define 'name' field in frontmatter or root element"
|
|
86
|
+
severity: "high"
|
|
87
|
+
|
|
88
|
+
- id: "workflow_description_required"
|
|
89
|
+
description: "Workflow entry files must include 'description' explaining the workflow's purpose"
|
|
90
|
+
severity: "high"
|
|
91
|
+
|
|
92
|
+
- id: "workflow_config_source"
|
|
93
|
+
description: "Workflows should reference config_source for variable resolution (e.g., {project-root}/_bmad/module/config.yaml)"
|
|
94
|
+
severity: "medium"
|
|
95
|
+
|
|
96
|
+
- id: "workflow_installed_path"
|
|
97
|
+
description: "Workflows should define installed_path for relative file references within the workflow"
|
|
98
|
+
severity: "medium"
|
|
99
|
+
|
|
100
|
+
- id: "valid_step_references"
|
|
101
|
+
description: "Step file references in workflow entry must point to existing files"
|
|
102
|
+
severity: "high"
|
|
103
|
+
|
|
104
|
+
# ============================================
|
|
105
|
+
# SHARDED WORKFLOW STEP RULES
|
|
106
|
+
# ============================================
|
|
107
|
+
workflow_steps:
|
|
108
|
+
description: "Individual step files in sharded workflows"
|
|
109
|
+
globs:
|
|
110
|
+
- "src/**/workflows/**/steps/step-*.md"
|
|
111
|
+
rules:
|
|
112
|
+
- id: "step_goal_required"
|
|
113
|
+
description: "Each step must clearly state its goal (## STEP GOAL, ## YOUR TASK, or step n='X' goal='...')"
|
|
114
|
+
severity: "high"
|
|
115
|
+
|
|
116
|
+
- id: "step_mandatory_rules"
|
|
117
|
+
description: "Step files should include MANDATORY EXECUTION RULES section with universal agent behavior rules"
|
|
118
|
+
severity: "medium"
|
|
119
|
+
|
|
120
|
+
- id: "step_context_boundaries"
|
|
121
|
+
description: "Step files should define CONTEXT BOUNDARIES explaining available context and limits"
|
|
122
|
+
severity: "medium"
|
|
123
|
+
|
|
124
|
+
- id: "step_success_metrics"
|
|
125
|
+
description: "Step files should include SUCCESS METRICS section with ✅ checkmarks for validation criteria"
|
|
126
|
+
severity: "medium"
|
|
127
|
+
|
|
128
|
+
- id: "step_failure_modes"
|
|
129
|
+
description: "Step files should include FAILURE MODES section with ❌ marks for anti-patterns to avoid"
|
|
130
|
+
severity: "medium"
|
|
131
|
+
|
|
132
|
+
- id: "step_next_step_reference"
|
|
133
|
+
description: "Step files should reference the next step file path for sequential execution"
|
|
134
|
+
severity: "medium"
|
|
135
|
+
|
|
136
|
+
- id: "step_no_forward_loading"
|
|
137
|
+
description: "Steps must NOT load future step files until current step completes - just-in-time loading only"
|
|
138
|
+
severity: "high"
|
|
139
|
+
|
|
140
|
+
- id: "valid_file_references"
|
|
141
|
+
description: "File path references using {variable}/filename.md must point to existing files"
|
|
142
|
+
severity: "high"
|
|
143
|
+
|
|
144
|
+
- id: "step_naming"
|
|
145
|
+
description: "Step files must be named step-NN-description.md (e.g., step-01-init.md, step-02-context.md)"
|
|
146
|
+
severity: "medium"
|
|
147
|
+
|
|
148
|
+
- id: "halt_before_menu"
|
|
149
|
+
description: "Steps presenting user menus ([C] Continue, [a] Advanced, etc.) must HALT and wait for response"
|
|
150
|
+
severity: "high"
|
|
151
|
+
|
|
152
|
+
# ============================================
|
|
153
|
+
# XML WORKFLOW/TASK RULES
|
|
154
|
+
# ============================================
|
|
155
|
+
xml_workflows:
|
|
156
|
+
description: "XML-based workflows and tasks"
|
|
157
|
+
globs:
|
|
158
|
+
- "src/**/workflows/**/*.xml"
|
|
159
|
+
- "src/**/tasks/**/*.xml"
|
|
160
|
+
rules:
|
|
161
|
+
- id: "xml_task_id_required"
|
|
162
|
+
description: "XML tasks must have unique 'id' attribute on root task element"
|
|
163
|
+
severity: "high"
|
|
164
|
+
|
|
165
|
+
- id: "xml_llm_instructions"
|
|
166
|
+
description: "XML workflows should include <llm> section with critical execution instructions for the agent"
|
|
167
|
+
severity: "medium"
|
|
168
|
+
|
|
169
|
+
- id: "xml_step_numbering"
|
|
170
|
+
description: "XML steps should use n='X' attribute for sequential numbering"
|
|
171
|
+
severity: "medium"
|
|
172
|
+
|
|
173
|
+
- id: "xml_action_tags"
|
|
174
|
+
description: "Use <action> for required actions, <ask> for user input (must HALT), <goto> for jumps, <check if='...'> for conditionals"
|
|
175
|
+
severity: "medium"
|
|
176
|
+
|
|
177
|
+
- id: "xml_ask_must_halt"
|
|
178
|
+
description: "<ask> tags require agent to HALT and wait for user response before continuing"
|
|
179
|
+
severity: "high"
|
|
180
|
+
|
|
181
|
+
# ============================================
|
|
182
|
+
# WORKFLOW CONTENT QUALITY
|
|
183
|
+
# ============================================
|
|
184
|
+
workflow_content:
|
|
185
|
+
description: "Content quality and consistency rules for all workflow files"
|
|
186
|
+
globs:
|
|
187
|
+
- "src/**/workflows/**/*.md"
|
|
188
|
+
- "src/**/workflows/**/*.yaml"
|
|
189
|
+
rules:
|
|
190
|
+
- id: "communication_language_variable"
|
|
191
|
+
description: "Workflows should use {communication_language} variable for agent output language consistency"
|
|
192
|
+
severity: "low"
|
|
193
|
+
|
|
194
|
+
- id: "path_placeholders_required"
|
|
195
|
+
description: "Use path placeholders (e.g. {project-root}, {installed_path}, {output_folder}) instead of hardcoded paths"
|
|
196
|
+
severity: "medium"
|
|
197
|
+
|
|
198
|
+
- id: "no_time_estimates"
|
|
199
|
+
description: "Workflows should NOT include time estimates - AI development speed varies significantly"
|
|
200
|
+
severity: "low"
|
|
201
|
+
|
|
202
|
+
- id: "facilitator_not_generator"
|
|
203
|
+
description: "Workflow agents should act as facilitators (guide user input) not content generators (create without input)"
|
|
204
|
+
severity: "medium"
|
|
205
|
+
|
|
206
|
+
- id: "no_skip_optimization"
|
|
207
|
+
description: "Workflows must execute steps sequentially - no skipping or 'optimizing' step order"
|
|
208
|
+
severity: "high"
|
|
209
|
+
|
|
210
|
+
# ============================================
|
|
211
|
+
# AGENT DEFINITIONS
|
|
212
|
+
# ============================================
|
|
213
|
+
agent_definitions:
|
|
214
|
+
description: "Agent YAML configuration files"
|
|
215
|
+
globs:
|
|
216
|
+
- "src/**/*.agent.yaml"
|
|
217
|
+
rules:
|
|
218
|
+
- id: "agent_metadata_required"
|
|
219
|
+
description: "Agent files must have metadata section with id, name, title, icon, and module"
|
|
220
|
+
severity: "high"
|
|
221
|
+
|
|
222
|
+
- id: "agent_persona_required"
|
|
223
|
+
description: "Agent files must define persona with role, identity, communication_style, and principles"
|
|
224
|
+
severity: "high"
|
|
225
|
+
|
|
226
|
+
- id: "agent_menu_valid_workflows"
|
|
227
|
+
description: "Menu triggers must reference valid workflow paths that exist"
|
|
228
|
+
severity: "high"
|
|
229
|
+
|
|
230
|
+
# ============================================
|
|
231
|
+
# TEMPLATES
|
|
232
|
+
# ============================================
|
|
233
|
+
templates:
|
|
234
|
+
description: "Template files for workflow outputs"
|
|
235
|
+
globs:
|
|
236
|
+
- "src/**/template*.md"
|
|
237
|
+
- "src/**/templates/**/*.md"
|
|
238
|
+
rules:
|
|
239
|
+
- id: "placeholder_syntax"
|
|
240
|
+
description: "Use {variable_name} or {{variable_name}} syntax consistently for placeholders"
|
|
241
|
+
severity: "medium"
|
|
242
|
+
|
|
243
|
+
- id: "template_sections_marked"
|
|
244
|
+
description: "Template sections that need generation should be clearly marked (e.g., <!-- GENERATE: section_name -->)"
|
|
245
|
+
severity: "low"
|
|
246
|
+
|
|
247
|
+
# ============================================
|
|
248
|
+
# DOCUMENTATION
|
|
249
|
+
# ============================================
|
|
250
|
+
documentation:
|
|
251
|
+
description: "Documentation files"
|
|
252
|
+
globs:
|
|
253
|
+
- "docs/**/*.md"
|
|
254
|
+
- "README.md"
|
|
255
|
+
- "CONTRIBUTING.md"
|
|
256
|
+
rules:
|
|
257
|
+
- id: "valid_internal_links"
|
|
258
|
+
description: "Internal markdown links must point to existing files"
|
|
259
|
+
severity: "medium"
|
|
260
|
+
|
|
261
|
+
# ============================================
|
|
262
|
+
# BUILD TOOLS
|
|
263
|
+
# ============================================
|
|
264
|
+
build_tools:
|
|
265
|
+
description: "Build scripts and tooling"
|
|
266
|
+
globs:
|
|
267
|
+
- "tools/**"
|
|
268
|
+
rules:
|
|
269
|
+
- id: "script_error_handling"
|
|
270
|
+
description: "Scripts should handle errors gracefully with proper exit codes"
|
|
271
|
+
severity: "medium"
|
package/.coderabbit.yaml
CHANGED
|
@@ -17,21 +17,66 @@ reviews:
|
|
|
17
17
|
base_branches:
|
|
18
18
|
- main
|
|
19
19
|
path_filters:
|
|
20
|
+
# --- Shared baseline: tool configs ---
|
|
21
|
+
- "!.coderabbit.yaml"
|
|
22
|
+
- "!.augment/**"
|
|
23
|
+
- "!eslint.config.mjs"
|
|
24
|
+
# --- Shared baseline: build output ---
|
|
25
|
+
- "!dist/**"
|
|
26
|
+
- "!build/**"
|
|
27
|
+
- "!coverage/**"
|
|
28
|
+
# --- Shared baseline: vendored/generated ---
|
|
20
29
|
- "!**/node_modules/**"
|
|
30
|
+
- "!**/*.min.js"
|
|
31
|
+
- "!**/*.generated.*"
|
|
32
|
+
- "!**/*.bundle.md"
|
|
33
|
+
# --- Shared baseline: package metadata ---
|
|
34
|
+
- "!package-lock.json"
|
|
35
|
+
# --- Shared baseline: binary/media ---
|
|
36
|
+
- "!*.png"
|
|
37
|
+
- "!*.jpg"
|
|
38
|
+
- "!*.svg"
|
|
39
|
+
# --- Shared baseline: test fixtures ---
|
|
40
|
+
- "!test/fixtures/**"
|
|
41
|
+
- "!test/template-test-generator/**"
|
|
42
|
+
- "!tools/template-test-generator/test-scenarios/**"
|
|
43
|
+
# --- Shared baseline: non-project dirs ---
|
|
44
|
+
- "!_bmad*/**"
|
|
45
|
+
- "!website/**"
|
|
46
|
+
- "!z*/**"
|
|
47
|
+
- "!sample-project/**"
|
|
48
|
+
- "!test-project-install/**"
|
|
49
|
+
# --- Shared baseline: AI assistant dirs ---
|
|
50
|
+
- "!.claude/**"
|
|
51
|
+
- "!.codex/**"
|
|
52
|
+
- "!.agent/**"
|
|
53
|
+
- "!.agentvibes/**"
|
|
54
|
+
- "!.kiro/**"
|
|
55
|
+
- "!.roo/**"
|
|
56
|
+
- "!.github/chatmodes/**"
|
|
57
|
+
# --- Shared baseline: build temp ---
|
|
58
|
+
- "!.bundler-temp/**"
|
|
59
|
+
# --- Shared baseline: generated reports ---
|
|
60
|
+
- "!**/validation-report-*.md"
|
|
61
|
+
- "!CHANGELOG.md"
|
|
21
62
|
path_instructions:
|
|
22
63
|
- path: "**/*"
|
|
23
64
|
instructions: |
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
65
|
+
You are a cynical, jaded reviewer with zero patience for sloppy work.
|
|
66
|
+
This PR was submitted by a clueless weasel and you expect to find problems.
|
|
67
|
+
Be skeptical of everything.
|
|
68
|
+
Look for what's missing, not just what's wrong.
|
|
69
|
+
Use a precise, professional tone — no profanity or personal attacks.
|
|
70
|
+
|
|
71
|
+
Review with extreme skepticism — assume problems exist.
|
|
72
|
+
Find at least 10 issues to fix or improve.
|
|
73
|
+
|
|
74
|
+
Do NOT:
|
|
75
|
+
- Comment on formatting, linting, or style
|
|
76
|
+
- Give "looks good" passes
|
|
77
|
+
- Anchor on any specific ruleset — reason freely
|
|
78
|
+
|
|
79
|
+
If you find zero issues, re-analyze — this is suspicious.
|
|
35
80
|
chat:
|
|
36
81
|
auto_reply: true # Response to mentions in comments, a la @coderabbit review
|
|
37
82
|
issue_enrichment:
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
## What
|
|
2
|
+
<!-- 1-2 sentences describing WHAT changed -->
|
|
3
|
+
|
|
4
|
+
## Why
|
|
5
|
+
<!-- 1-2 sentences explaining WHY this change is needed -->
|
|
6
|
+
<!-- Fixes `#issue_number` (if applicable) -->
|
|
7
|
+
|
|
8
|
+
## How
|
|
9
|
+
<!-- 2-3 bullets listing HOW you implemented it -->
|
|
10
|
+
-
|
|
11
|
+
|
|
12
|
+
## Testing
|
|
13
|
+
<!-- 1-2 sentences on how you tested this -->
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
name: Trigger CodeRabbit on Ready for Review
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request_target:
|
|
5
|
+
types: [ready_for_review]
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
trigger-review:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
permissions:
|
|
11
|
+
pull-requests: write
|
|
12
|
+
steps:
|
|
13
|
+
- name: Request CodeRabbit review
|
|
14
|
+
uses: actions/github-script@v7
|
|
15
|
+
with:
|
|
16
|
+
script: |
|
|
17
|
+
await github.rest.issues.createComment({
|
|
18
|
+
owner: context.repo.owner,
|
|
19
|
+
repo: context.repo.repo,
|
|
20
|
+
issue_number: context.payload.pull_request.number,
|
|
21
|
+
body: '@coderabbitai review'
|
|
22
|
+
});
|
|
@@ -6,9 +6,8 @@ on:
|
|
|
6
6
|
- main
|
|
7
7
|
paths:
|
|
8
8
|
- "docs/**"
|
|
9
|
-
- "src/modules/*/docs/**"
|
|
10
9
|
- "website/**"
|
|
11
|
-
- "tools/build-docs.
|
|
10
|
+
- "tools/build-docs.mjs"
|
|
12
11
|
- ".github/workflows/docs.yaml"
|
|
13
12
|
workflow_dispatch:
|
|
14
13
|
|
|
@@ -19,6 +18,7 @@ permissions:
|
|
|
19
18
|
|
|
20
19
|
concurrency:
|
|
21
20
|
group: "pages"
|
|
21
|
+
# No big win in setting this to true — risk of cancelling a deploy mid-flight.
|
|
22
22
|
cancel-in-progress: false
|
|
23
23
|
|
|
24
24
|
jobs:
|
|
@@ -28,12 +28,13 @@ jobs:
|
|
|
28
28
|
- name: Checkout repository
|
|
29
29
|
uses: actions/checkout@v4
|
|
30
30
|
with:
|
|
31
|
+
# Full history needed for Starlight's lastUpdated timestamps (git log)
|
|
31
32
|
fetch-depth: 0
|
|
32
33
|
|
|
33
34
|
- name: Setup Node.js
|
|
34
35
|
uses: actions/setup-node@v4
|
|
35
36
|
with:
|
|
36
|
-
node-version: "
|
|
37
|
+
node-version-file: ".nvmrc"
|
|
37
38
|
cache: "npm"
|
|
38
39
|
|
|
39
40
|
- name: Install dependencies
|
|
@@ -84,10 +84,8 @@ jobs:
|
|
|
84
84
|
- name: Install dependencies
|
|
85
85
|
run: npm ci
|
|
86
86
|
|
|
87
|
-
- name: Validate documentation links
|
|
88
|
-
run: npm run docs:validate-links
|
|
89
|
-
|
|
90
87
|
- name: Build documentation
|
|
88
|
+
# Note: build-docs.mjs runs link validation internally before building
|
|
91
89
|
run: npm run docs:build
|
|
92
90
|
|
|
93
91
|
validate:
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,58 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [6.0.0-Beta.8]
|
|
4
|
+
|
|
5
|
+
**Release: February 8, 2026**
|
|
6
|
+
|
|
7
|
+
### 🌟 Key Highlights
|
|
8
|
+
|
|
9
|
+
1. **Non-Interactive Installation** — Full CI/CD support with 10 new CLI flags for automated deployments
|
|
10
|
+
2. **Complete @clack/prompts Migration** — Unified CLI experience with consolidated installer output
|
|
11
|
+
3. **CSV File Reference Validation** — Extended Layer 1 validator to catch broken workflow references in CSV files
|
|
12
|
+
4. **Kiro IDE Support** — Standardized config-driven installation, replacing custom installer
|
|
13
|
+
|
|
14
|
+
### 🎁 Features
|
|
15
|
+
|
|
16
|
+
* **Non-Interactive Installation** — Added `--directory`, `--modules`, `--tools`, `--custom-content`, `--user-name`, `--communication-language`, `--document-output-language`, `--output-folder`, and `-y/--yes` flags for CI/CD automation (#1520)
|
|
17
|
+
* **CSV File Reference Validation** — Extended validator to scan `.csv` files for broken workflow references, checking 501 references across 212 files (#1573)
|
|
18
|
+
* **Kiro IDE Support** — Replaced broken custom installer with config-driven templates using `#[[file:...]]` syntax and `inclusion: manual` frontmatter (#1589)
|
|
19
|
+
* **OpenCode Template Consolidation** — Combined split templates with `mode: primary` frontmatter for Tab-switching support, fixing agent discovery (#1556)
|
|
20
|
+
* **Modules Reference Page** — Added official external modules reference documentation (#1540)
|
|
21
|
+
|
|
22
|
+
### 🐛 Bug Fixes
|
|
23
|
+
|
|
24
|
+
* **Installer Streamlining** — Removed "None - Skip module installation" option, eliminated ~100 lines of dead code, and added ESM/.cjs support for module installers (#1590)
|
|
25
|
+
* **CodeRabbit Workflow** — Changed `pull_request` to `pull_request_target` to fix 403 errors and enable reviews on fork PRs (#1583)
|
|
26
|
+
* **Party Mode Return Protocol** — Added RETURN PROTOCOL to prevent lost-in-the-middle failures after Party Mode completes (#1569)
|
|
27
|
+
* **Spacebar Toggle** — Fixed SPACE key not working in autocomplete multiselect prompts for tool/IDE selection (#1557)
|
|
28
|
+
* **OpenCode Agent Routing** — Fixed agents installing to wrong directory by adding `targets` array for routing `.opencode/agent/` vs `.opencode/command/` (#1549)
|
|
29
|
+
* **Technical Research Workflow** — Fixed step-05 routing to step-06 and corrected `stepsCompleted` values (#1547)
|
|
30
|
+
* **Forbidden Variable Removal** — Removed `workflow_path` variable from 16 workflow step files (#1546)
|
|
31
|
+
* **Kilo Installer** — Fixed YAML formatting issues by trimming activation header and converting to yaml.parse/stringify (#1537)
|
|
32
|
+
* **bmad-help** — Now reads project-specific docs and respects `communication_language` setting (#1535)
|
|
33
|
+
* **Cache Errors** — Removed `--prefer-offline` npm flag to prevent stale cache errors during installation (#1531)
|
|
34
|
+
|
|
35
|
+
### ♻️ Refactoring
|
|
36
|
+
|
|
37
|
+
* **Complete @clack/prompts Migration** — Migrated 24 files from legacy libraries (ora, chalk, boxen, figlet, etc.), replaced ~100 console.log+chalk calls, consolidated installer output to single spinner, and removed 5 dependencies (#1586)
|
|
38
|
+
* **Downloads Page Removal** — Removed downloads page, bundle generation, and archiver dependency in favor of GitHub's native archives (#1577)
|
|
39
|
+
* **Workflow Verb Standardization** — Replaced "invoke/run" with "load and follow/load" in review workflow prompts (#1570)
|
|
40
|
+
* **Documentation Language** — Renamed "brownfield" to "established projects" and flattened directory structure for accessibility (#1539)
|
|
41
|
+
|
|
42
|
+
### 📚 Documentation
|
|
43
|
+
|
|
44
|
+
* **Comprehensive Site Review** — Fixed broken directory tree diagram, corrected grammar/capitalization, added SEO descriptions, and reordered how-to guides (#1578)
|
|
45
|
+
* **SEO Metadata** — Added description front matter to 9 documentation pages for search engine optimization (#1566)
|
|
46
|
+
* **PR Template** — Added pull request template for consistent PR descriptions (#1554)
|
|
47
|
+
* **Manual Release Cleanup** — Removed broken manual-release workflow and related scripts (#1576)
|
|
48
|
+
|
|
49
|
+
### 🔧 Maintenance
|
|
50
|
+
|
|
51
|
+
* **Dual-Mode AI Code Review** — Configured Augment Code (audit mode) and CodeRabbit (adversarial mode) for improved code quality (#1511)
|
|
52
|
+
* **Package-Lock Sync** — Cleaned up 471 lines of orphaned dependencies after archiver removal (#1580)
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
3
56
|
## [6.0.0-Beta.7]
|
|
4
57
|
|
|
5
58
|
**Release: February 4, 2026**
|
package/CONTRIBUTING.md
CHANGED
|
@@ -147,6 +147,15 @@ Keep messages under 72 characters. Each commit = one logical change.
|
|
|
147
147
|
- Everything is natural language (markdown) — no code in core framework
|
|
148
148
|
- Use BMad modules for domain-specific features
|
|
149
149
|
- Validate YAML schemas: `npm run validate:schemas`
|
|
150
|
+
- Validate file references: `npm run validate:refs`
|
|
151
|
+
|
|
152
|
+
### File-Pattern-to-Validator Mapping
|
|
153
|
+
|
|
154
|
+
| File Pattern | Validator | Extraction Function |
|
|
155
|
+
| ------------ | --------- | ------------------- |
|
|
156
|
+
| `*.yaml`, `*.yml` | `validate-file-refs.js` | `extractYamlRefs` |
|
|
157
|
+
| `*.md`, `*.xml` | `validate-file-refs.js` | `extractMarkdownRefs` |
|
|
158
|
+
| `*.csv` | `validate-file-refs.js` | `extractCsvRefs` |
|
|
150
159
|
|
|
151
160
|
---
|
|
152
161
|
|
package/README.md
CHANGED
|
@@ -30,6 +30,14 @@ npx bmad-method install
|
|
|
30
30
|
|
|
31
31
|
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
|
|
32
32
|
|
|
33
|
+
**Non-Interactive Installation**: For CI/CD pipelines or automated deployments, use command-line flags:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npx bmad-method install --directory /path/to/project --modules bmm --tools claude-code --yes
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
See [Non-Interactive Installation Guide](http://docs.bmad-method.org/how-to/non-interactive-installation/) for all available options.
|
|
40
|
+
|
|
33
41
|
> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask it questions like:
|
|
34
42
|
|
|
35
43
|
- `/bmad-help How should I build a web app for my TShirt Business that can scale to millions?`
|
package/docs/404.md
CHANGED
package/docs/_STYLE_GUIDE.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Documentation Style Guide"
|
|
3
|
+
description: Project-specific documentation conventions based on Google style and Diataxis structure
|
|
3
4
|
---
|
|
4
5
|
|
|
5
6
|
This project adheres to the [Google Developer Documentation Style Guide](https://developers.google.com/style) and uses [Diataxis](https://diataxis.fr/) to structure content. Only project-specific conventions follow.
|
|
@@ -147,7 +148,7 @@ your-project/
|
|
|
147
148
|
| **Concept** | `what-are-agents.md` |
|
|
148
149
|
| **Feature** | `quick-flow.md` |
|
|
149
150
|
| **Philosophy** | `why-solutioning-matters.md` |
|
|
150
|
-
| **FAQ** | `
|
|
151
|
+
| **FAQ** | `established-projects-faq.md` |
|
|
151
152
|
|
|
152
153
|
### General Template
|
|
153
154
|
|
|
@@ -325,7 +326,7 @@ Add italic context at definition start for limited-scope terms:
|
|
|
325
326
|
- `*BMad Method/Enterprise.*`
|
|
326
327
|
- `*Phase N.*`
|
|
327
328
|
- `*BMGD.*`
|
|
328
|
-
- `*
|
|
329
|
+
- `*Established projects.*`
|
|
329
330
|
|
|
330
331
|
### Glossary Checklist
|
|
331
332
|
|
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Advanced Elicitation"
|
|
3
3
|
description: Push the LLM to rethink its work using structured reasoning methods
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 6
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
Make the LLM reconsider what it just generated. You pick a reasoning method, it applies that method to its own output, you decide whether to keep the improvements.
|
|
7
9
|
|
|
8
|
-
|
|
10
|
+
## What is Advanced Elicitation?
|
|
11
|
+
|
|
12
|
+
A structured second pass. Instead of asking the AI to "try again" or "make it better," you select a specific reasoning method and the AI re-examines its own output through that lens.
|
|
13
|
+
|
|
14
|
+
The difference matters. Vague requests produce vague revisions. A named method forces a particular angle of attack, surfacing insights that a generic retry would miss.
|
|
9
15
|
|
|
10
16
|
## When to Use It
|
|
11
17
|
|
|
@@ -22,3 +28,22 @@ Workflows offer advanced elicitation at decision points - after the LLM has gene
|
|
|
22
28
|
2. You pick one (or reshuffle for different options)
|
|
23
29
|
3. Method is applied, improvements shown
|
|
24
30
|
4. Accept or discard, repeat or continue
|
|
31
|
+
|
|
32
|
+
## Built-in Methods
|
|
33
|
+
|
|
34
|
+
Dozens of reasoning methods are available. A few examples:
|
|
35
|
+
|
|
36
|
+
- **Pre-mortem Analysis** - Assume the project already failed, work backward to find why
|
|
37
|
+
- **First Principles Thinking** - Strip away assumptions, rebuild from ground truth
|
|
38
|
+
- **Inversion** - Ask how to guarantee failure, then avoid those things
|
|
39
|
+
- **Red Team vs Blue Team** - Attack your own work, then defend it
|
|
40
|
+
- **Socratic Questioning** - Challenge every claim with "why?" and "how do you know?"
|
|
41
|
+
- **Constraint Removal** - Drop all constraints, see what changes, add them back selectively
|
|
42
|
+
- **Stakeholder Mapping** - Re-evaluate from each stakeholder's perspective
|
|
43
|
+
- **Analogical Reasoning** - Find parallels in other domains and apply their lessons
|
|
44
|
+
|
|
45
|
+
And many more. The AI picks the most relevant options for your content - you choose which to run.
|
|
46
|
+
|
|
47
|
+
:::tip[Start Here]
|
|
48
|
+
Pre-mortem Analysis is a good first pick for any spec or plan. It consistently finds gaps that a standard review misses.
|
|
49
|
+
:::
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Adversarial Review"
|
|
3
3
|
description: Forced reasoning technique that prevents lazy "looks good" reviews
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 5
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
Force deeper analysis by requiring problems to be found.
|
|
@@ -24,7 +26,7 @@ Normal reviews suffer from confirmation bias. You skim the work, nothing jumps o
|
|
|
24
26
|
|
|
25
27
|
## Where It's Used
|
|
26
28
|
|
|
27
|
-
Adversarial review appears throughout
|
|
29
|
+
Adversarial review appears throughout BMad workflows - code review, implementation readiness checks, spec validation, and others. Sometimes it's a required step, sometimes optional (like advanced elicitation or party mode). The pattern adapts to whatever artifact needs scrutiny.
|
|
28
30
|
|
|
29
31
|
## Human Filtering Required
|
|
30
32
|
|