mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-08-29 03:44:18 +08:00
Alex Verkhovsky
07f1a44c5c
Replace duplicated workflow-era rules in .augment/code_review_guidelines.yaml with a single reference to tools/skill-validator.md. Append the skill spec cheatsheet to the validator with a link to the Agent Skills specification. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
110 lines
3.5 KiB
YAML
110 lines
3.5 KiB
YAML
# Augment Code Review Guidelines for BMAD-METHOD
|
|
# https://docs.augmentcode.com/codereview/overview
|
|
# Focus: Skill validation and quality
|
|
# Canonical rules: tools/skill-validator.md (single source of truth)
|
|
|
|
file_paths_to_ignore:
|
|
# --- Shared baseline: tool configs ---
|
|
- ".coderabbit.yaml"
|
|
- ".augment/**"
|
|
- "eslint.config.mjs"
|
|
# --- Shared baseline: build output ---
|
|
- "dist/**"
|
|
- "build/**"
|
|
- "coverage/**"
|
|
# --- Shared baseline: vendored/generated ---
|
|
- "node_modules/**"
|
|
- "**/*.min.js"
|
|
- "**/*.generated.*"
|
|
- "**/*.bundle.md"
|
|
# --- Shared baseline: package metadata ---
|
|
- "package-lock.json"
|
|
# --- Shared baseline: binary/media ---
|
|
- "*.png"
|
|
- "*.jpg"
|
|
- "*.svg"
|
|
# --- Shared baseline: test fixtures ---
|
|
- "test/fixtures/**"
|
|
- "test/template-test-generator/**"
|
|
- "tools/template-test-generator/test-scenarios/**"
|
|
# --- Shared baseline: non-project dirs ---
|
|
- "_bmad*/**"
|
|
- "website/**"
|
|
- "z*/**"
|
|
- "sample-project/**"
|
|
- "test-project-install/**"
|
|
# --- Shared baseline: AI assistant dirs ---
|
|
- ".claude/**"
|
|
- ".codex/**"
|
|
- ".agent/**"
|
|
- ".agentvibes/**"
|
|
- ".kiro/**"
|
|
- ".roo/**"
|
|
- ".github/chatmodes/**"
|
|
# --- Shared baseline: build temp ---
|
|
- ".bundler-temp/**"
|
|
# --- Shared baseline: generated reports ---
|
|
- "**/validation-report-*.md"
|
|
- "CHANGELOG.md"
|
|
|
|
areas:
|
|
# ============================================
|
|
# SKILL FILES
|
|
# ============================================
|
|
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: "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"
|
|
|
|
# ============================================
|
|
# AGENT DEFINITIONS
|
|
# ============================================
|
|
agent_definitions:
|
|
description: "Agent YAML configuration files"
|
|
globs:
|
|
- "src/**/*.agent.yaml"
|
|
rules:
|
|
- id: "agent_metadata_required"
|
|
description: "Agent files must have metadata section with id, name, title, icon, and module"
|
|
severity: "high"
|
|
|
|
- id: "agent_persona_required"
|
|
description: "Agent files must define persona with role, identity, communication_style, and principles"
|
|
severity: "high"
|
|
|
|
- id: "agent_menu_valid_skills"
|
|
description: "Menu triggers must reference valid skill names that exist"
|
|
severity: "high"
|
|
|
|
# ============================================
|
|
# DOCUMENTATION
|
|
# ============================================
|
|
documentation:
|
|
description: "Documentation files"
|
|
globs:
|
|
- "docs/**/*.md"
|
|
- "README.md"
|
|
- "CONTRIBUTING.md"
|
|
rules:
|
|
- id: "valid_internal_links"
|
|
description: "Internal markdown links must point to existing files"
|
|
severity: "medium"
|
|
|
|
# ============================================
|
|
# BUILD TOOLS
|
|
# ============================================
|
|
build_tools:
|
|
description: "Build scripts and tooling"
|
|
globs:
|
|
- "tools/**"
|
|
rules:
|
|
- id: "script_error_handling"
|
|
description: "Scripts should handle errors gracefully with proper exit codes"
|
|
severity: "medium"
|