bmad-checkpoint-preview

$npx mdskill add bmad-code-org/BMAD-METHOD/bmad-checkpoint-preview

Guides human review of a change with LLM assistance.

  • Helps users review changes when they say 'checkpoint' or 'human review'.
  • Depends on Python script and TOML customization files.
  • Resolves workflow from layered customization files with merge rules.
  • Returns a JSON object with headline and four bullet points.

SKILL.md

.github/skills/bmad-checkpoint-previewView on GitHub ↗
---
name: bmad-checkpoint-preview
description: 'LLM-assisted human-in-the-loop review. Make sense of a change, focus attention where it matters, test. Use when the user says "checkpoint", "human review", or "walk me through this change".'
---

# Checkpoint Review Workflow

**Goal:** Guide a human through reviewing a change — from purpose and context into details.

**Your Role:** You are assisting the user in reviewing a change.

## Conventions

- Bare paths (e.g. `step-01-orientation.md`) resolve from the skill root.
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
- `{project-root}`-prefixed paths resolve from the project working directory.
- `{skill-name}` resolves to the skill directory's basename.

## On Activation

### Step 1: Resolve the Workflow Block

Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`

**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:

1. `{skill-root}/customize.toml` — defaults
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides

Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.

### Step 2: Execute Prepend Steps

Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.

### Step 3: Load Persistent Facts

Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.

### Step 4: Load Config

Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:

- `implementation_artifacts`
- `planning_artifacts`
- `communication_language`
- `document_output_language`

### Step 5: Greet the User

Greet the user, speaking in `{communication_language}`.

### Step 6: Execute Append Steps

Execute each entry in `{workflow.activation_steps_append}` in order.

Activation is complete. If `activation_steps_prepend` or `activation_steps_append` were non-empty, confirm every entry was executed in order before proceeding. Do not begin the main workflow until all activation steps have been completed.

## Global Step Rules (apply to every step)

- **Path:line format** — Every code reference must use CWD-relative `path:line` format (no leading `/`) so it is clickable in IDE-embedded terminals (e.g., `src/auth/middleware.ts:42`).
- **Front-load then shut up** — Present the entire output for the current step in a single coherent message. Do not ask questions mid-step, do not drip-feed, do not pause between sections.
- **Language** — Speak in `{communication_language}`. Write any file output in `{document_output_language}`.

## FIRST STEP

Read fully and follow `./step-01-orientation.md` to begin.

More from bmad-code-org/BMAD-METHOD

SkillDescription
bmad-advanced-elicitationPush the LLM to reconsider, refine, and improve its recent output. Use when user asks for deeper critique or mentions a known deeper critique method, e.g. socratic, first principles, pre-mortem, red team.
bmad-agent-analystStrategic business analyst and requirements expert. Use when the user asks to talk to Mary or requests the business analyst.
bmad-agent-architectSystem architect and technical design leader. Use when the user asks to talk to Winston or requests the architect.
bmad-agent-devSenior software engineer for story execution and code implementation. Use when the user asks to talk to Amelia or requests the developer agent.
bmad-agent-pmProduct manager for PRD creation and requirements discovery. Use when the user asks to talk to John or requests the product manager.
bmad-agent-tech-writerTechnical documentation specialist and knowledge curator. Use when the user asks to talk to Paige or requests the tech writer.
bmad-agent-ux-designerUX designer and UI specialist. Use when the user asks to talk to Sally or requests the UX designer.
bmad-architectureProduce the architecture: a lean spine of invariants that keeps everything built from it consistent, projected into whatever format the work needs. Use when the user says "create the architecture", "create technical architecture", "architecture spine", or "create a solution design".
bmad-brainstormingFacilitate a brainstorming session using diverse creative techniques. Use when the user says 'help me brainstorm' or 'help me ideate'.
bmad-check-implementation-readinessValidate PRD, UX, Architecture and Epics specs are complete. Use when the user says "check implementation readiness".