ros/BMAD-METHOD
1
0
Fork 0
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git synced 2026-01-30 04:32:02 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cc7635172bc69d7d24f87f8fe570bd36fa8692dc
BMAD-METHOD/docs/how-to/workflows/run-code-review.md
forcetrainer e535f94325 docs: comprehensive style guide update with reference and glossary standards 
Style Guide Additions:
- Add Reference Structure section with 6 document types (Index, Catalog,
  Deep-Dive, Configuration, Glossary, Comprehensive)
- Add Glossary Structure section with table-based format leveraging
  Starlight's right-nav for navigation
- Include checklists for both new document types

Reference Docs Updated:
- agents/index.md: Catalog format, universal commands tip admonition
- configuration/core-tasks.md: Configuration format with admonitions
- configuration/global-config.md: Table-based config reference
- workflows/index.md: Minimal index format
- workflows/core-workflows.md: Catalog format
- workflows/document-project.md: Deep-dive with Quick Facts admonition
- workflows/bmgd-workflows.md: Comprehensive format, removed ~30 hr rules

Glossary Rewritten:
- Converted from 373 lines with ### headers to 123 lines with tables
- Right nav now shows 9 categories instead of 50+ terms
- Added italic context markers (*BMGD.*, *Brownfield.*, etc.)
- Alphabetized terms within categories
- Removed redundant inline TOC

All Docs:
- Remove horizontal rules (---) per style guide
- Remove "Related" sections (sidebar handles navigation)
- Standardize admonition usage
- Archive deleted workflow customization docs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-12 00:23:05 -05:00

2.4 KiB
Raw Blame History

title, description
title description
How to Run Code Review How to run code review for quality assurance

Use the code-review workflow to perform a thorough quality review of implemented code.

When to Use This

  • After dev-story completes implementation
  • Before marking a story as DONE
  • Every story goes through code review — no exceptions

:::note[Prerequisites]

  • BMad Method installed
  • DEV agent available
  • Story implementation complete
  • Tests written and passing :::

Steps

1. Load the DEV Agent

Start a fresh chat (or continue from dev-story) and load the DEV agent.

2. Run the Workflow

*code-review

3. Provide Context

Point the agent to:

  • The story file
  • Files changed during implementation
  • Test files

4. Review Findings

The agent performs a senior developer code review and reports findings.

5. Address Issues

If issues are found:

  1. Fix issues using dev-story
  2. Re-run tests
  3. Run code-review again

What Gets Reviewed

Category Checks
Code Quality Clean code, appropriate abstractions, no code smells, proper error handling
Architecture Alignment Follows ADRs, consistent with patterns, proper separation of concerns
Testing Adequate coverage, meaningful tests, edge cases, follows project patterns
Security No hardcoded secrets, input validation, proper auth, no common vulnerabilities
Performance No obvious issues, appropriate data structures, efficient queries

Review Outcomes

Approved — Code meets quality standards, tests pass. Mark story as DONE in sprint-status.yaml.

Changes Requested — Issues identified that need fixing. Fix issues in dev-story, then re-run code-review.

Quality Gates

Every story goes through code-review before being marked done. This ensures:

  • Consistent code quality
  • Architecture adherence
  • Test coverage
  • Security review

Tips

  • Don't skip for "simple" changes — Simple changes can have subtle bugs
  • Address all findings — Not just critical ones
  • Use findings as learning opportunities — Improve over time
  • Re-run review after fixes — Verify issues are resolved

Next Steps

After code review:

  1. If approved — Update sprint-status.yaml to mark story DONE
  2. If changes requested — Fix issues and re-run review
  3. Move to next story — Run create-story for the next item