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
12d3492e0c81793ce09c057688c5828870fbe27c
BMAD-METHOD/docs/how-to/workflows/run-code-review.md
forcetrainer 12d3492e0c Add link auditor, reorganize documentation, and README update (#1277) 
* feat: add link auditor tools and fix broken docs links

- Add audit-doc-links.js to scan docs for broken links with auto-resolution
- Add fix-doc-links.js to apply suggested fixes (dry-run by default)
- Remove stale "Back to Core Concepts" breadcrumb links
- Update BMad acronym to "Breakthrough Method of Agile AI Driven Development"
- Update README links to docs.bmad-method.org
- Simplify upgrade callout in getting-started tutorial

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: reorganize docs structure and archive v4 tutorial

- Remove unused section index files (tutorials, how-to, explanation, reference)
- Move getting-started-bmadv4.md to _archive
- Update quick-start-bmgd.md to remove archived file reference
- Update upgrade-to-v6.md
- Update astro.config.mjs for new structure

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: ignore underscore directories in link checker

Update check-doc-links.js to skip _archive, _planning, and other
underscore-prefixed directories when validating links.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: add v4 users section to README

Add links to v4 documentation archive and upgrade guide for users
migrating from previous versions.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: convert docs to site-relative links and add validation tools

- Convert all relative links (./  ../) to site-relative paths (/path/)
- Strip .md extensions and use trailing slashes for Astro/Starlight
- Add fix-doc-links.js to convert relative links to site-relative
- Add validate-doc-links.js to check links point to existing files
- Remove old audit-doc-links.js and check-doc-links.js
- Update build-docs.js to use new validation script
- Add npm scripts: docs:fix-links, docs:validate-links
- Update style guide with validation steps

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: standardize acronym to BMad across documentation

Replace incorrect "BMAD" with correct "BMad" in text and frontmatter
while preserving "BMAD-METHOD" in GitHub URLs.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: fix BMad acronym and remove draft README

- Correct acronym to "Breakthrough Method of Agile AI Driven Development"
- Remove unused README-draft.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: standardize BMad acronym in README

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: standardize FAQ format across all FAQ pages

- Add TOC with jump links under "## Questions"
- Use ### headers for questions (no Q: prefix)
- Direct answers without **A:** prefix
- Remove horizontal rules and "Related Documentation" sections
- End each FAQ with issue/Discord CTA
- Update style guide with new FAQ guidelines
- Delete redundant faq/index.md (sidebar handles navigation)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: use repo-relative links with .md for GitHub compatibility

Convert all documentation links to repo-relative format (/docs/path/file.md)
so they work when browsing on GitHub. The rehype plugin strips /docs/ prefix
and converts .md to trailing slash at build time for Astro/Starlight.

- Update rehype-markdown-links.js to strip /docs/ prefix from absolute paths
- Update fix-doc-links.js to generate /docs/ prefixed paths with .md extension
- Convert 217 links across 64 files to new format

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: handle /docs/ prefix in link validator

Update resolveLink to strip /docs/ prefix from repo-relative links
before checking if files exist.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: restore FAQ index page

Re-add the FAQ index page that was accidentally deleted, with
updated repo-relative link format.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
2026-01-10 02:55:33 +08:00

2.7 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

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

The code review checks:

Code Quality

  • Clean, readable code
  • Appropriate abstractions
  • No code smells
  • Proper error handling

Architecture Alignment

  • Follows ADRs and architecture decisions
  • Consistent with existing patterns
  • Proper separation of concerns

Testing

  • Adequate test coverage
  • Tests are meaningful (not just for coverage)
  • Edge cases handled
  • Tests follow project patterns

Security

  • No hardcoded secrets
  • Input validation
  • Authentication/authorization proper
  • No common vulnerabilities

Performance

  • No obvious performance issues
  • Appropriate data structures
  • Efficient queries

Review Outcomes

✅ Approved

  • Code meets quality standards
  • Tests pass
  • Action: Mark story as DONE in sprint-status.yaml

🔧 Changes Requested

  • Issues identified that need fixing
  • Action: 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 code review for "simple" changes
  • Address all findings, not just critical ones
  • Use findings as learning opportunities
  • Re-run review after fixes

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

Related