Skip to content

feat: add bmad-checkpoint-preview skill#2145

Merged
alexeyv merged 16 commits intomainfrom
feat/bmad-checkpoint
Apr 1, 2026
Merged

feat: add bmad-checkpoint-preview skill#2145
alexeyv merged 16 commits intomainfrom
feat/bmad-checkpoint

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Mar 27, 2026

Summary

  • Adds bmad-checkpoint-preview skill to src/bmm-skills/4-implementation/ — a guided, concern-ordered change walkthrough for human review of commits, branches, or PRs
  • Copied from the av-human-review experiment skill, adapted to BMAD multi-step conventions (SKILL.md → workflow.md → step chain)
  • Registered in module-help.csv (sequence 55, post-Code Review)

Test plan

  • Run npm ci && npm run quality in the worktree
  • Install into a harness and verify the skill appears in the module help
  • Invoke via "walk me through this change" and confirm step progression

🤖 Generated with Claude Code

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 27, 2026

🤖 Augment PR Summary

Summary: This PR introduces a new implementation-phase skill, bmad-checkpoint-preview, for guided, human-friendly change walkthroughs.

Changes:

  • Added a new skill directory under src/bmm-skills/4-implementation/ with SKILL.md and a step-based workflow.
  • Implemented a 4-step sequence: Orientation → Walkthrough → Detail Pass → Testing.
  • Orientation step includes intent framing plus optional diff-based surface-area stats and a fallback “review trail” generator.
  • Walkthrough step structures the review by concerns (not files) and outputs navigable path:line stops.
  • Detail Pass step highlights high blast-radius risk spots and supports targeted deep-dives.
  • Testing step suggests manual, observable verification actions and defines a wrap-up flow.
  • Registered the new skill in module help (CSV update).

Technical Notes: Workflow loads module config via {project-root}/_bmad/bmm/config.yaml, relies on git-diff baselines for stats/trails, and uses BMAD multi-step conventions for progressive disclosure.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 3 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

📝 Walkthrough

Walkthrough

This PR introduces documentation for a new "bmad-checkpoint-preview" skill, defining a structured code review workflow. It includes a skill entry point, main workflow configuration, and four sequential review steps (orientation, walkthrough, detail pass, testing) that guide reviewers through analyzing changes with specific procedures for understanding scope, organizing concerns, identifying risks, and verifying behavior.

Changes

Cohort / File(s) Summary
Skill Entry Point
SKILL.md, workflow.md
Defines the skill metadata, configuration loading, and directs users to the step-by-step review process.
Review Steps
step-01-orientation.md, step-02-walkthrough.md, step-03-detail-pass.md, step-04-testing.md
Specifies four sequential phases: (1) interpreting change context and computing surface area stats, (2) organizing and presenting concerns with code references, (3) identifying risk-sensitive patterns across categories (auth, API, schema, billing, etc.), and (4) guiding manual testing verification.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • BMAD-METHOD#1868: Establishes SKILL.md as the canonical skill entrypoint and installer validation target, which directly aligns with this PR's use of SKILL.md to define the bmad-checkpoint-preview skill.
  • BMAD-METHOD#2033: Implements Review Trail generation in step 5, related to this PR's fallback review trail generation logic added in the orientation step.
  • BMAD-METHOD#2049: Adjusts clickable path:line/link conventions in workflow documentation, relevant to this PR's enforcement of clickable path:line references across all review steps.

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat: add bmad-checkpoint-preview skill' directly and accurately summarizes the main change—adding a new skill to the codebase with specific naming and purpose.
Description check ✅ Passed The description is clearly related to the changeset, providing context on what the skill does, its origin, how it was adapted, where it's registered, and a test plan.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/bmad-checkpoint
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch feat/bmad-checkpoint

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/bmm-skills/4-implementation/bmad-checkpoint-preview/workflow.md (1)

20-20: Consider clarifying the phrasing.

"YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style" has slightly awkward phrasing. Consider: "Format all output according to your agent communication style for {communication_language}" or "All output must use the agent communication style specified by {communication_language}".

✨ Proposed refinement
-YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}`.
+Format all output according to your agent communication style for `{communication_language}`.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/bmm-skills/4-implementation/bmad-checkpoint-preview/workflow.md` at line
20, The sentence "YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style
with the config `{communication_language}`." is awkwardly phrased; update the
line in workflow.md (the string containing that exact sentence) to clearer
wording such as "Format all output according to your agent communication style
for `{communication_language}`" or "All output must use the agent communication
style specified by `{communication_language}`" so the intent is unambiguous and
reads naturally.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@src/bmm-skills/4-implementation/bmad-checkpoint-preview/step-01-orientation.md`:
- Line 56: Replace the shortened empty-tree SHA used in the "Bare commit"
example (currently `4b825dc`) with the full hash
`4b825dc642cb6eb9a060e54bf8d69288fbee4904` so the diff command
(`4b825dc..commit` example) works reliably; update the line that reads "**Bare
commit**: Diff against parent (`commit~1..commit`). For merge commits, use
`--first-parent`. For initial commits, diff against the empty tree
(`4b825dc..commit`)." to use the full SHA instead of the shortened form.

---

Nitpick comments:
In `@src/bmm-skills/4-implementation/bmad-checkpoint-preview/workflow.md`:
- Line 20: The sentence "YOU MUST ALWAYS SPEAK OUTPUT in your Agent
communication style with the config `{communication_language}`." is awkwardly
phrased; update the line in workflow.md (the string containing that exact
sentence) to clearer wording such as "Format all output according to your agent
communication style for `{communication_language}`" or "All output must use the
agent communication style specified by `{communication_language}`" so the intent
is unambiguous and reads naturally.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a08044fb-c3f9-4cc2-83d7-91f407ddff43

📥 Commits

Reviewing files that changed from the base of the PR and between 513f440 and 93d928d.

⛔ Files ignored due to path filters (1)
  • src/bmm-skills/module-help.csv is excluded by !**/*.csv
📒 Files selected for processing (6)
  • src/bmm-skills/4-implementation/bmad-checkpoint-preview/SKILL.md
  • src/bmm-skills/4-implementation/bmad-checkpoint-preview/step-01-orientation.md
  • src/bmm-skills/4-implementation/bmad-checkpoint-preview/step-02-walkthrough.md
  • src/bmm-skills/4-implementation/bmad-checkpoint-preview/step-03-detail-pass.md
  • src/bmm-skills/4-implementation/bmad-checkpoint-preview/step-04-testing.md
  • src/bmm-skills/4-implementation/bmad-checkpoint-preview/workflow.md

alexeyv and others added 8 commits April 1, 2026 07:12
Copies the av-human-review experiment skill into BMAD-METHOD as
bmad-checkpoint, following established multi-step skill conventions
(SKILL.md → workflow.md → step chain). Registered in module-help.csv
under 4-implementation phase.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ep rules

Remove separate workflow.md — its content now lives directly in SKILL.md
with merged frontmatter. Replace scattered standing rules with a structured
Global Step Rules section (path:line format, front-load output, comm style).
Steps 2–4 now reference Global Step Rules in SKILL.md instead of
restating path:line format, front-load, and silence rules locally.
Step-specific rules (concern-based org, design judgment, risk
awareness, experiential testing) are preserved.
SKILL.md frontmatter should only contain name and description.
Hardcode the config path inline in the INITIALIZATION section.
Rewrite description to reflect the skills purpose as an LLM-assisted
human-in-the-loop review. Add checkpoint trigger, drop stale triggers.
…ken budget

Use CWD-relative path:line in fallback trail (not markdown links),
cap full-file reads at ~50k tokens, remove over-prompted empty-tree SHA.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@alexeyv alexeyv force-pushed the feat/bmad-checkpoint branch from 92b7150 to beeb2e1 Compare April 1, 2026 14:17
alexeyv and others added 8 commits April 1, 2026 07:44
…scade

Replace the ad-hoc change-finding logic with a clean 1-5 cascade
modeled after quick-dev Intent Check: explicit argument, recent
conversation, sprint tracking, current git state, ask. Extract
spec/commit pairing into a separate ENRICH step that runs after
any cascade level resolves. Add planning_artifacts to SKILL.md
initialization.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… step-01

Replace opaque Review Mode table with explicit set-variable instructions.
Scope terse commit message handling to bare-commit mode only.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… bullets

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…scade

Replace rigid with-spec/bare-commit split with a 4-level fallback:
baseline_commit, merge-base, HEAD~1, skip. Omit metrics that
cannot be computed rather than failing.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…-trail.md

Reduce step-01 bloat by moving the conditional trail generation
sub-routine into its own file, loaded only when review mode is
not full-trail.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace undefined "I've seen enough" exits with proper early-exit
handling across steps 02-04. Extract wrap-up logic into dedicated
step-05-wrapup.md. Fix step-02 menu text that incorrectly promised
"code review" when step-03 does risk surfacing.
@alexeyv
Copy link
Copy Markdown
Collaborator Author

alexeyv commented Apr 1, 2026

Triage Complete: 4 findings — FIX: 2, DISMISS: 2, DEFER: 0

# Severity Title Decision
F1 MEDIUM "Run code review" promise mismatches step-03 risk-surfacing scope FIX
F2 MEDIUM "I've seen enough" exit has no routing/handling FIX
F3 MEDIUM Fallback trail uses leading-slash paths and ambiguous basenames DISMISS
F4 MINOR Empty tree SHA should use full hash DISMISS

Fix Details

  • F1: Replaced "and run code review" with "for your review" in step-02 menu to match step-03 risk-surfacing scope
  • F2: Created step-05-wrapup.md as canonical wrap-up step; replaced magic "I've seen enough" phrase with natural intent detection + confirmation in steps 02/03/04

Dismissal Rationale

  • F3: False positive — the file is never executed standalone, always in context of the referring step
  • F4: False positive — the empty tree SHA (4b825dc) does not exist anywhere in the file or codebase

@alexeyv alexeyv merged commit 1b776f5 into main Apr 1, 2026
5 checks passed
@alexeyv alexeyv deleted the feat/bmad-checkpoint branch April 1, 2026 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant