visual-recap

Files (6)

• SKILL.md
• block-format.md · references/
• check-primitives-map.mjs · scripts/
• classify-primitives.mjs · scripts/
• primitives-map.mjs · scripts/
• upsert-recap-block.mjs · scripts/

SKILL.md (first lines)

# System recap

When a change is non-trivial (a plan, a PR create or update, or a request for a
visual recap), put one marker-delimited block in the PR description. GitHub
renders it. It does not replace reading the diff.

## When

**Recap mode reads the diff, not memory.** Claims about what changed must be
checkable against `git diff <base>...HEAD` (plus `--stat`). Session context may
explain intent only.

Run the classifier. Roll up to the highest of `adds`, then `extends`, then
`composes`. You still choose `composes` vs `extends` from the diff. `adds` is a
new map entry.

| Rollup     | Risk   | Also                                                                                                      |
| ---------- | ------ | --------------------------------------------------------------------------------------------------------- |
| `composes` | low    | Wiring and call sites only.                                                                               |
| `extends`  | medium | Verify locally with the project's control CLI as the seeded user; a PR preview only when local cannot     |
| `adds`     | high   | Update `primitives.yaml`, run `check-primitives-map.mjs`, and the same local verify (preview when needed) |

Update `primitives.yaml` when this PR adds, removes, or materially reshapes a
primitive (new `id`, renamed meaning, or ownership roots that must change). Do
not edit `summary` for ordinary feature work. Call out a touched invariant from
that map at every risk.

Plan mode uses `**Mode:** plan` before a PR exists. Recap mode replaces that
block from `git diff <base>...HEAD`. In plan mode, say explicitly when the plan
requires **no** change to any primitive; that is the lowest-risk outcome.

The block shape is one example:
[references/block-format.md](./references/block-format.md).

## Command

```bash
node .agents/skills/visual-recap/scripts/classify-primitives.mjs --base <base> --head HEAD --json
node .agents/skills/visual-recap/scripts/upsert-recap-block.mjs <pr-number> <block-file>
node .agents/skills/visual-recap/scripts/check-primitives-map.mjs
```

The upsert script checks mermaid, then replaces the marker block or appends it.
It does not edit text outside the markers. Re-run both commands after a
significant push.

## Failure

- The mermaid check exits non-zero. Fix the diagram. Keep `;` out of sequence
  notes and messages.
- The block file must start with `<!-- system-recap:start -->` and end with
  `<!-- system-recap:end -->`.
- `gh pr edit` fails with
  `Resource not accessible by integration (updatePullRequest)`. The script still
  prints the merged body. Apply that body with Cursor ManagePullRequest. Do not
  have Kody edit the PR.
- A health check or login smoke is not medium or high verification. Prefer local
  control CLI proof; use a preview only when local cannot exercise the change.
  Do not cat the session cookie into curl or Python.

From kentcdodds/kcd-skills, MIT.

More from kentcdodds/kcd-skills