agentleFS
lucasaguilarlucasaguilar/rei/skills/change-walkthrough/SKILL.md

change-walkthrough

Skill8 starsChanged 5 months agoMITView on GitHub

Explain a set of code changes (working tree, a commit, or a branch range like development..HEAD) so a human can follow them — what changed and why, the order to read the files, a small Mermaid flow diagram, and what to look at carefully. Use when asked to explain, walk through, summarize or diagram a diff, commit or branch. Read-only; it does not review for bugs or change code.

5 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions5 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 5

    1. siarhei-belavus/agent-smitt★ 4same name
    2. AbdouMoumen/claude-skills-plugin★ 1same name
    3. rekram1-node/skills★ 1same name
    4. 5hseok/hanipman-gate★ 0same name
    5. justEstif/pi-shelf★ 0same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository3 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use when the user wants to *understand* a set of changes: "explain this diff", "what did this commit do", "walk me through the branch", …

    line 9
  2. Distinctive:

    Write the walkthrough in the user's language.

    line 15
  3. Very specific:

    Write only the `` mermaid ``` block.

    line 66
  4. Distinctive:

    If the change has no meaningful flow (renames, styles, copy, config), skip the diagram and say so in one line — do not draw a diagram for …

    line 69
  5. Distinctive:

    Read-only: Do not edit files, stage, commit or run anything that changes state.

    line 74
  6. Distinctive:

    Ground every claim: Every file, function or connection mentioned must come from the diff or from code you actually read.

    line 75

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Skill: Change walkthrough (read a diff, follow it, diagram it)

Use when the user wants to understand a set of changes: "explain this diff", "what did this commit do", "walk me through the branch", "diagram the flow of this change". The goal is that the user can read and own the change, not a bug review (that is a separate code-review step).

Output language

Write the walkthrough in the user's language. Code identifiers, file paths and the Mermaid node labels that name code stay in their original form.

Steps

  1. Resolve the range — do not ask if it is obvious.
    • User gave a commit, range or branch → use it (git show <sha>, git diff <a>..<b>).
    • Otherwise, uncommitted changes exist (git status --porcelain) → the working tree (git diff + git diff --staged, plus untracked files from git status).
    • Otherwise → the current branch against its base (git merge-base HEAD <base>; the base is the one the project docs name, else development/main/master, whichever exists). State the range you used in one line.
  2. Read the changes. git diff --stat first for the shape, then the full diff. For each changed file, read enough of the surrounding code (callers, the store/service it feeds, the template that renders it) to explain how the change connects. Never describe a connection you have not read.
  3. Find the flow. Identify the entry point (route, user action, API call, lifecycle hook, CLI command) and follow the data/event through the changed code to where it ends (UI, request, state, output).
  4. Write the walkthrough in the format below. Keep it short: it is a reading guide, not a copy of the diff.

Output format

## Walkthrough — <range>

**What changed and why:** <3–5 lines: the intent, the behavior before vs after>

**Reading order:**
1. `<path>` — <one line: what changed here and its role>
2. ...
(model/types → helpers → store/service → component → template/styles → tests)

**Flow:**
```mermaid
flowchart LR
  A[<entry point>] --> B[<changed unit>] --> C[<result>]
```

**Look at carefully:**
- <behavior changes, edge cases, null/empty/error paths, anything not covered by tests>

Diagram rules

  • Mermaid only, small: 5–10 nodes. flowchart LR for a data/event flow, sequenceDiagram only when the order of calls between 3+ parties is the point (e.g. component → store → API).
  • Nodes are real units from the code (function, store method, component, endpoint). Mark the ones this change adds or modifies with a trailing * in the label (e.g. submit()*).
  • Quote labels that contain parentheses, brackets or other punctuation (B["submit()*"]) — unquoted () inside [...] breaks the Mermaid parser.
  • Write only the ```mermaid block. Do not build a viewer link or encode the diagram yourself — an encoded URL written by a model is invented bytes. (REI adds an "open diagram" link under each block on its own.)
  • If the change has no meaningful flow (renames, styles, copy, config), skip the diagram and say so in one line — do not draw a diagram for the sake of it.

Hard rules

  • Read-only. Do not edit files, stage, commit or run anything that changes state.
  • Ground every claim. Every file, function or connection mentioned must come from the diff or from code you actually read.
  • Large diffs (more than ~15 files or ~800 changed lines): say so, give "What changed and why" and the reading order for the whole range, and offer to walk through it in parts (by commit or by folder) instead of guessing at the details.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.