Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 11 additions & 133 deletions .augment/code_review_guidelines.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Augment Code Review Guidelines for BMAD-METHOD
# https://docs.augmentcode.com/codereview/overview
# Focus: Workflow validation and quality
# Focus: Skill validation and quality
# Canonical rules: tools/skill-validator.md (single source of truth)

file_paths_to_ignore:
# --- Shared baseline: tool configs ---
Expand Down Expand Up @@ -48,123 +49,17 @@ file_paths_to_ignore:

areas:
# ============================================
# WORKFLOW STRUCTURE RULES
# SKILL FILES
# ============================================
workflow_structure:
description: "Workflow folder organization and required components"
skill_files:
description: "All skill content — SKILL.md, workflow.md, step files, data files, and templates within skill directories"
globs:
- "src/**/skills/**"
- "src/**/workflows/**"
- "src/**/tasks/**"
rules:
- id: "workflow_entry_point_required"
description: "Every workflow folder must have workflow.md as entry point"
severity: "high"

- id: "sharded_workflow_steps_folder"
description: "Sharded workflows (using workflow.md) must have steps/ folder with numbered files (step-01-*.md, step-02-*.md)"
severity: "high"

- id: "workflow_step_limit"
description: "Workflows should have 5-10 steps maximum to prevent context loss in LLM execution"
severity: "medium"

# ============================================
# WORKFLOW ENTRY FILE RULES
# ============================================
workflow_definitions:
description: "Workflow entry files (workflow.md)"
globs:
- "src/**/workflows/**/workflow.md"
rules:
- id: "workflow_name_required"
description: "Workflow entry files must define 'name' field in frontmatter or root element"
severity: "high"

- id: "workflow_description_required"
description: "Workflow entry files must include 'description' explaining the workflow's purpose"
severity: "high"

- id: "workflow_installed_path"
description: "Workflows should define installed_path for relative file references within the workflow"
severity: "medium"

- id: "valid_step_references"
description: "Step file references in workflow entry must point to existing files"
severity: "high"

# ============================================
# SHARDED WORKFLOW STEP RULES
# ============================================
workflow_steps:
description: "Individual step files in sharded workflows"
globs:
- "src/**/workflows/**/steps/step-*.md"
rules:
- id: "step_goal_required"
description: "Each step must clearly state its goal (## STEP GOAL, ## YOUR TASK, or step n='X' goal='...')"
severity: "high"

- id: "step_mandatory_rules"
description: "Step files should include MANDATORY EXECUTION RULES section with universal agent behavior rules"
severity: "medium"

- id: "step_context_boundaries"
description: "Step files should define CONTEXT BOUNDARIES explaining available context and limits"
severity: "medium"

- id: "step_success_metrics"
description: "Step files should include SUCCESS METRICS section with ✅ checkmarks for validation criteria"
severity: "medium"

- id: "step_failure_modes"
description: "Step files should include FAILURE MODES section with ❌ marks for anti-patterns to avoid"
severity: "medium"

- id: "step_next_step_reference"
description: "Step files should reference the next step file path for sequential execution"
severity: "medium"

- id: "step_no_forward_loading"
description: "Steps must NOT load future step files until current step completes - just-in-time loading only"
severity: "high"

- id: "valid_file_references"
description: "File path references using {variable}/filename.md must point to existing files"
severity: "high"

- id: "step_naming"
description: "Step files must be named step-NN-description.md (e.g., step-01-init.md, step-02-context.md)"
severity: "medium"

- id: "halt_before_menu"
description: "Steps presenting user menus ([C] Continue, [a] Advanced, etc.) must HALT and wait for response"
severity: "high"

# ============================================
# WORKFLOW CONTENT QUALITY
# ============================================
workflow_content:
description: "Content quality and consistency rules for all workflow files"
globs:
- "src/**/workflows/**/*.md"
rules:
- id: "communication_language_variable"
description: "Workflows should use {communication_language} variable for agent output language consistency"
severity: "low"

- id: "path_placeholders_required"
description: "Use path placeholders (e.g. {project-root}, {installed_path}, {output_folder}) instead of hardcoded paths"
severity: "medium"

- id: "no_time_estimates"
description: "Workflows should NOT include time estimates - AI development speed varies significantly"
severity: "low"

- id: "facilitator_not_generator"
description: "Workflow agents should act as facilitators (guide user input) not content generators (create without input)"
severity: "medium"

- id: "no_skip_optimization"
description: "Workflows must execute steps sequentially - no skipping or 'optimizing' step order"
- id: "skill_validation"
description: "Apply the full rule catalog defined in tools/skill-validator.md. That file is the single source of truth for all skill validation rules covering SKILL.md metadata, workflow.md constraints, step file structure, path references, variable resolution, sequential execution, and skill invocation syntax."
severity: "high"

# ============================================
Expand All @@ -183,27 +78,10 @@ areas:
description: "Agent files must define persona with role, identity, communication_style, and principles"
severity: "high"

- id: "agent_menu_valid_workflows"
description: "Menu triggers must reference valid workflow paths that exist"
- id: "agent_menu_valid_skills"
description: "Menu triggers must reference valid skill names that exist"
severity: "high"

# ============================================
# TEMPLATES
# ============================================
templates:
description: "Template files for workflow outputs"
globs:
- "src/**/template*.md"
- "src/**/templates/**/*.md"
rules:
- id: "placeholder_syntax"
description: "Use {variable_name} or {{variable_name}} syntax consistently for placeholders"
severity: "medium"

- id: "template_sections_marked"
description: "Template sections that need generation should be clearly marked (e.g., <!-- GENERATE: section_name -->)"
severity: "low"

# ============================================
# DOCUMENTATION
# ============================================
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/quality.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Quality & Validation

# Runs comprehensive quality checks on all PRs:
# Runs comprehensive quality checks on all PRs and pushes to main:
# - Prettier (formatting)
# - ESLint (linting)
# - markdownlint (markdown quality)
Expand All @@ -10,6 +10,8 @@ name: Quality & Validation
# Keep this workflow aligned with `npm run quality` in `package.json`.

"on":
push:
branches: [main]
pull_request:
branches: ["**"]
workflow_dispatch:
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ npm-debug.log*
# Build output
build/*.txt

design-artifacts/

# Environment variables
.env

Expand Down
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
# Changelog

## v6.2.0 - 2026-03-15

### 🎁 Highlights

* Fix manifest generation so BMad Builder installs correctly when a module has no agents (#1998)
* Prototype preview of bmad-product-brief-preview skill — try `/bmad-product-brief-preview` and share feedback! (#1959)
* All skills now use native skill directory format for improved modularity and maintainability (#1931, #1945, #1946, #1949, #1950, #1984, #1985, #1988, #1994)

### 🎁 Features

* Rewrite code-review skill with sharded step-file architecture and auto-detect review intent from invocation args (#2007, #2013)
* Add inference-based skill validator with comprehensive rules for naming, variables, paths, and invocation syntax (#1981)
* Add REF-03 skill invocation language rule and PATH-05 skill encapsulation rule to validator (#2004)

### 🐛 Bug Fixes

* Validation pass 2 — fix path, variable, and sequence issues across 32 files (#2008)
* Replace broken party-mode workflow refs with skill syntax (#2000)
* Improve bmad-help description for accurate trigger matching (#2012)
* Point zh-cn doc links to Chinese pages instead of English (#2010)
* Validation cleanup for bmad-quick-flow (#1997), 6 skills batch (#1996), bmad-sprint-planning (#1995), bmad-retrospective (#1993), bmad-dev-story (#1992), bmad-create-story (#1991), bmad-code-review (#1990), bmad-create-epics-and-stories (#1989), bmad-create-architecture (#1987), bmad-check-implementation-readiness (#1986), bmad-create-ux-design (#1983), bmad-create-product-brief (#1982)

### 🔧 Maintenance

* Normalize skill invocation syntax to `Invoke the skill` pattern repo-wide (#2004)

### 📚 Documentation

* Add Chinese translation for core-tools reference (#2002)
* Update version hint, TEA module link, and HTTP→HTTPS links in Chinese README (#1922, #1921)

## [6.1.0] - 2026-03-12

### Highlights
Expand Down
2 changes: 1 addition & 1 deletion docs/_STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation.

### Can I change my plan later?

Yes. The SM agent has a `bmad-correct-course` workflow for handling scope changes.
Yes. Use `bmad-correct-course` for handling scope changes.

**Have a question not answered here?** [Open an issue](...) or ask in [Discord](...).
```
Expand Down
8 changes: 4 additions & 4 deletions docs/explanation/quick-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ Quick Flow has two skills, each backed by a structured workflow. You can run the

### quick-spec: Plan

Run `bmad-quick-spec` and Barry (the Quick Flow agent) walks you through a conversational discovery process:
Run `bmad-quick-spec` and the agent walks you through a conversational discovery process:

1. **Understand** - You describe what you want to build. Barry scans the codebase to ask informed questions, then captures a problem statement, solution approach, and scope boundaries.
2. **Investigate** - Barry reads relevant files, maps code patterns, identifies files to modify, and documents the technical context.
1. **Understand** - You describe what you want to build. The agent scans the codebase to ask informed questions, then captures a problem statement, solution approach, and scope boundaries.
2. **Investigate** - It reads relevant files, maps code patterns, identifies files to modify, and documents the technical context.
3. **Generate** - Produces a complete tech-spec with ordered implementation tasks (specific file paths and actions), acceptance criteria in Given/When/Then format, testing strategy, and dependencies.
4. **Review** - Presents the full spec for your sign-off. You can edit, ask questions, run adversarial review, or refine with advanced elicitation before finalizing.

The output is a `tech-spec-{slug}.md` file saved to your project's implementation artifacts folder. It contains everything a fresh agent needs to implement the feature - no conversation history required.

### quick-dev: Build

Run `bmad-quick-dev` and Barry implements the work. It operates in two modes:
Run `bmad-quick-dev` and the agent implements the work. It operates in two modes:

- **Tech-spec mode** - Point it at a spec file (`quick-dev tech-spec-auth.md`) and it executes every task in order, writes tests, and verifies acceptance criteria.
- **Direct mode** - Give it instructions directly (`quick-dev "refactor the auth middleware"`) and it gathers context, builds a mental plan, and executes.
Expand Down
7 changes: 3 additions & 4 deletions docs/how-to/customize-bmad.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,8 @@ After installation, find one `.customize.yaml` file per agent in:

```text
_bmad/_config/agents/
├── core-bmad-master.customize.yaml
├── bmm-dev.customize.yaml
├── bmm-pm.customize.yaml
├── bmm-analyst.customize.yaml
├── bmm-architect.customize.yaml
└── ... (one file per installed agent)
```

Expand All @@ -59,7 +58,7 @@ Change how the agent introduces itself:
```yaml
agent:
metadata:
name: 'Spongebob' # Default: "Amelia"
name: 'Spongebob' # Default: "Mary"
```

**Persona**
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/established-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ You have two primary options depending on the scope of changes:

| Scope | Recommended Approach |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| **Small updates or additions** | Use `bmad-quick-flow-solo-dev` to create a tech-spec and implement the change. The full four-phase BMad Method is likely overkill. |
| **Small updates or additions** | Use `bmad-quick-spec` to create a tech-spec, then `bmad-quick-dev` to implement the change. The full four-phase BMad Method is likely overkill. |
| **Major changes or additions** | Start with the BMad Method, applying as much or as little rigor as needed. |

### During PRD Creation
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/get-answers-about-bmad.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Use this section when:

| Source | Best For | Examples |
| -------------------- | ----------------------------------------- | ---------------------------- |
| **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the PM agent do?" |
| **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the Analyst agent do?" |
| **Full GitHub repo** | History, installer, architecture | "What changed in v6?" |
| **`llms-full.txt`** | Quick overview from docs | "Explain BMad's four phases" |

Expand Down
Loading
Loading