pr
The shape of a pull request body: a summary diagram, before/after evidence, and merge danger. Use when opening a PR, writing or rewriting a PR description, or when another flow needs a PR body.
Install
npx skills add https://github.com/svyatov/supermatt/tree/main/skills/pr
claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install svyatov-supermatt@llmmart
git clone https://github.com/svyatov/supermatt.git
The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole svyatov/supermatt collection as a plugin from our marketplace. Git is the plain clone.
Skill manifest
Use this template for writing the PR body:
## Summary
<diagram, diff-sketch, or tree>
## Evidence
- **Before:** <screenshot/output/failing test run>
**After:** <screenshot/output/passing test run>
## Merge danger
**Door:** <one-way or two-way>
<optional: description>
**Blast radius:** <one-word description>
<optional: potential ramifications of merge>
Sections
Skip all preambles and keep prose brief. Use the user's domain language from the glossary (docs/agents/domain.md gives the layout; by default GLOSSARY.md).
Summary
Pick the smallest view that makes the key point clear.
- Show logic or an algorithm as pseudocode:
on(save)
if content is unchanged
return cached result
write new content
return fresh result
- Show runtime control flow as a call tree:
submitForm
createSession
persistPrompt
launchAgent
navigateToSession
- Show UI structure as a component tree, including state and module boundaries that matter:
<SessionPage> // apps/example/src/routes/session.tsx
useSessionEvents()
<SessionToolbar>
<RunSkillButton /> // packages/ui
- Show file responsibility or a broad refactor as a shallow file tree:
src/
├── commands/ # parses user actions
├── sessions/ # owns session state
└── transport/ # sends API requests
- Show component interaction, control flow, or data flow with Mermaid:
sequenceDiagram
participant User
participant UI
participant Daemon
User->>UI: choose command
UI->>Daemon: send expanded prompt
Daemon-->>UI: stream result
- Use
diffwhen the point is what changes and the surrounding shape already exists. Match the diff shape to the topic.
For a component change:
<SessionPage>
useSessionEvents()
<SessionToolbar>
+ <RunSkillButton />
<SessionTimeline>
+ <SkillResultCard />
For a file-layout change:
src/
├── commands/
+│ └── show-me.ts # expands the slash command
├── sessions/
-└── transport.ts
+└── transport/
+ ├── client.ts
+ └── stream.ts
For a call-tree or call-stack change:
submitForm
createSession
persistPrompt
+ expandSkillMention
launchAgent
- navigateToSession
+ navigateToSession
+ subscribeToEvents
For a state or control-flow change:
on(save)
- write content
+ if content is unchanged
+ return cached result
+ write new content
+ invalidate cache
- Show the whole block when most of it is new, when omitted context would hide ownership or order, or when the user needs a copyable target shape:
function expandSkill(command: string): string {
const skillName = command.slice(1);
return `use the ${skillName} skill`;
}
Guidance
Place each visual next to the short text it supports. Keep only the calls, files, props, states, and boundaries a reviewer needs to understand the change.
You may use one of these, you may use several, it is unlikely you will use all of them. Use your judgement and don't overwhelm the user.
Evidence
Concrete evidence that the change works. Show a before and after when both were captured. For a rewrite, preserve the supplied evidence and its limits; rewriting the description does not establish that checks ran. If a before state or executable check is unavailable or not applicable, say which evidence is missing and why, report only observed results, and leave the verification gap explicit.
Screenshots are S-tier, when the environment is set up for it and the change is visual.
Execution-based evidence is A-tier. Report the actual test commands, results, and checked revision. A failing-before/passing-after claim needs observations of both runs. Pseudocode may explain the tested behavior when labeled illustrative; it is not an executed test or proof of a result.
Merge danger
Describe whether it's a one-way or two-way door. You can walk back through two-way doors, but not one-way doors. A PR that is cheap to roll back is lower risk. Changes that involve destructive actions or hard-to-reverse decisions are one-way doors.
The blast radius is the potential impact or scope of the changes introduced by this PR. Consider all possibilities. Examples are layout shift, breakages for consumers, mobile responsiveness, etc.
Files (supermatt)
-
agents
-
openai.yaml 104 B
Loading…
-
-
CREDITS.md 595 B
Loading… -
NOTICE 1.1 KB · in bundle
-
SKILL.md 4.8 KB
--- name: pr description: "The shape of a pull request body: a summary diagram, before/after evidence, and merge danger. Use when opening a PR, writing or rewriting a PR description, or when another flow needs a PR body." metadata: credits-skill: show-me credits-author: Dex Horthy credits-organisation: Humanlayer credits-url: "https://github.com/humanlayer/skills/tree/main/plugins/show-me/skills/show-me" license: MIT --- Use this template for writing the PR body: ```markdown ## Summary <diagram, diff-sketch, or tree> ## Evidence - **Before:** <screenshot/output/failing test run> **After:** <screenshot/output/passing test run> ## Merge danger **Door:** <one-way or two-way> <optional: description> **Blast radius:** <one-word description> <optional: potential ramifications of merge> ``` ## Sections Skip all preambles and keep prose brief. Use the user's domain language from the glossary (`docs/agents/domain.md` gives the layout; by default `GLOSSARY.md`). ### Summary Pick the smallest view that makes the key point clear. - Show logic or an algorithm as pseudocode: ```text on(save) if content is unchanged return cached result write new content return fresh result ``` - Show runtime control flow as a call tree: ```text submitForm createSession persistPrompt launchAgent navigateToSession ``` - Show UI structure as a component tree, including state and module boundaries that matter: ```tsx <SessionPage> // apps/example/src/routes/session.tsx useSessionEvents() <SessionToolbar> <RunSkillButton /> // packages/ui ``` - Show file responsibility or a broad refactor as a shallow file tree: ```text src/ ├── commands/ # parses user actions ├── sessions/ # owns session state └── transport/ # sends API requests ``` - Show component interaction, control flow, or data flow with Mermaid: ```mermaid sequenceDiagram participant User participant UI participant Daemon User->>UI: choose command UI->>Daemon: send expanded prompt Daemon-->>UI: stream result ``` - Use `diff` when the point is what changes and the surrounding shape already exists. Match the diff shape to the topic. For a component change: ```diff <SessionPage> useSessionEvents() <SessionToolbar> + <RunSkillButton /> <SessionTimeline> + <SkillResultCard /> ``` For a file-layout change: ```diff src/ ├── commands/ +│ └── show-me.ts # expands the slash command ├── sessions/ -└── transport.ts +└── transport/ + ├── client.ts + └── stream.ts ``` For a call-tree or call-stack change: ```diff submitForm createSession persistPrompt + expandSkillMention launchAgent - navigateToSession + navigateToSession + subscribeToEvents ``` For a state or control-flow change: ```diff on(save) - write content + if content is unchanged + return cached result + write new content + invalidate cache ``` - Show the whole block when most of it is new, when omitted context would hide ownership or order, or when the user needs a copyable target shape: ```ts function expandSkill(command: string): string { const skillName = command.slice(1); return `use the ${skillName} skill`; } ``` #### Guidance Place each visual next to the short text it supports. Keep only the calls, files, props, states, and boundaries a reviewer needs to understand the change. You may use one of these, you may use several, it is unlikely you will use all of them. Use your judgement and don't overwhelm the user. ### Evidence Concrete evidence that the change works. Show a before and after when both were captured. For a rewrite, preserve the supplied evidence and its limits; rewriting the description does not establish that checks ran. If a before state or executable check is unavailable or not applicable, say which evidence is missing and why, report only observed results, and leave the verification gap explicit. Screenshots are S-tier, when the environment is set up for it and the change is visual. Execution-based evidence is A-tier. Report the actual test commands, results, and checked revision. A failing-before/passing-after claim needs observations of both runs. Pseudocode may explain the tested behavior when labeled illustrative; it is not an executed test or proof of a result. ### Merge danger Describe whether it's a one-way or two-way door. You can walk back through two-way doors, but not one-way doors. A PR that is cheap to roll back is lower risk. Changes that involve destructive actions or hard-to-reverse decisions are one-way doors. The blast radius is the potential impact or scope of the changes introduced by this PR. Consider all possibilities. Examples are layout shift, breakages for consumers, mobile responsiveness, etc.
Comments (0)
Sign in to join the conversation.
Reviews (0)
No reviews yet.
No comments yet.