@bmad-code-org/bmad-walkthrough

@bmad-code-org/bmad-walkthrough — AI coding skill

View in AI SkillSafe app
0 downloads
0 stars
0 demos
SKILL.md
namebmad-walkthrough
descriptionWalk the user through reviewing a change: what it is for, what to look at closely, and how to test it. Use when the user says "walkthrough", "walk me through this change", or "human review"

Walkthrough 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: uv run {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --project-root {project-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

Run: uv run {project-root}/_bmad/scripts/resolve_config.py --project-root {project-root} --key modules.bmm.implementation_artifacts --key modules.bmm.planning_artifacts

Step 5: Greet the User

Greet the user.

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.

FIRST STEP

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

Embed badges

Add these to your README to show the skill's verification status.

SkillSafe verified badge
Verified badge
[![SkillSafe verified badge](https://api.skillsafe.ai/v1/badge/@bmad-code-org/bmad-walkthrough/verified)](https://skillsafe.ai/skill/@bmad-code-org/bmad-walkthrough/)
Installs badge
Installs badge
[![Installs badge](https://api.skillsafe.ai/v1/badge/@bmad-code-org/bmad-walkthrough/installs)](https://skillsafe.ai/skill/@bmad-code-org/bmad-walkthrough/)
Scan badge
Scan badge
[![Scan badge](https://api.skillsafe.ai/v1/badge/@bmad-code-org/bmad-walkthrough/scan)](https://skillsafe.ai/skill/@bmad-code-org/bmad-walkthrough/)
Eval pass rate badge
Eval pass rate
[![Eval pass rate badge](https://api.skillsafe.ai/v1/badge/@bmad-code-org/bmad-walkthrough/eval)](https://skillsafe.ai/skill/@bmad-code-org/bmad-walkthrough/)