bmad-review

Reviews diffs, pull requests, and documents through configurable lenses and reports triaged findings.

52.5k|6.0k|Updated Apr 13, 2025
One-click install
npx skills add https://github.com/bmad-code-org/BMAD-METHOD --skill bmad-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-review
Source: https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/core-skills/bmad-review
Command: npx skills add https://github.com/bmad-code-org/BMAD-METHOD --skill bmad-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Code and document reviews are inconsistent: reviewers miss edge cases, verification gaps go unnoticed, and editorial feedback varies by reviewer. This Skill runs structured review lenses — adversarial critique, edge-case tracing, verification-gap analysis, structure, and prose — over a diff, pull request, or document and returns findings in one canonical shape.

Core Features & Use Cases

  • Multi-lens review: Runs adversarial, edge-case-hunter, verification-gap, structure, and prose lenses, each with its own method and stance, selected automatically by content type or explicitly by the caller.
  • Canonical findings output: Every finding carries location, trigger condition, guard snippet, and potential consequence, rendered as JSON, markdown, or both.
  • Customizable workflow: Teams and individuals override lenses, style guides, review guidance, and output preferences through TOML override files without editing the shipped configuration.
  • Use Case: Ask for a review of an open pull request; the Skill stages the diff, runs the applicable lenses in parallel, and returns a triaged report grouping findings by lens — including unhandled edge cases and tests that would not catch a regression.

Quick Start

Ask the assistant to review the current branch's diff or a specific pull request and report the findings grouped by lens.

Frequently Asked Questions about bmad-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a pull request or diff with AI lenses?

Invoke the review with a path, branch, or uncommitted changes as the content. The Skill stages the diff to a temp file, selects applicable lenses, runs them, and returns findings with location, trigger condition, guard snippet, and potential consequence.

What review lenses are available for code and documents?

Five shipped lenses: adversarial critique, edge-case hunter for unhandled paths, verification-gap for missing test coverage, and editorial structure and prose lenses for documents. Teams can add or replace lenses through TOML override files.

Can I customize the review style guide and output format?

Yes. Team and personal TOML override files set the style guide, reader type, output format (json, markdown, or both), report path, and standing review guidance. Overrides merge with the shipped configuration per BMad structural rules.

Does the review run automatically on my edits?

No. The Skill runs only when explicitly asked to review a diff, pull request, or artifact, or when another skill issues an explicit skill:bmad-review directive. Acting on earlier feedback is treated as a change, not a review.

What happens when a review finds no issues?

An empty findings array is a valid result for most lenses, and the markdown report states the review is clean. The adversarial lens is the exception: it requires at least ten concrete findings and treats an empty list as a signal to re-check.