pr
For Wheelhouse's build steps: the template for a pull request's text.
- License 许可
- MIT
- 最近更新
- 2026-11-15
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- pr
- metadata
- { "credits": { "url": "https://github.com/humanlayer/skills/blob/main/plugins/show-me/skills/show-me/SKILL.md", "skill": "show-me", "author": "Dex Horthy", "organisation": "Humanlayer" } }
- description
- For Wheelhouse's build steps: the template for a pull request's text.
02 资源文件 3
- 参考文档CREDITS.md635 B
- 许可证LICENSE1.0 KB
- 参考文档SOURCE.md950 B
03 SKILL.md 正文
<!-- skills/pr/SKILL.md -->
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 project's domain language from its glossary, where it has one.
Keep every private record out. The repository may be public. The text never quotes the work order, the director's words, a card, a cost, a token count, a model, a run id or anything from Wheelhouse's own records. It describes the change and its evidence only.
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 reader 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 needed to show what the change does.
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 reader.
Evidence
Concrete evidence that the change works. Show a before and after.
Screenshots are S-tier - when the environment is set up for it and the change is visual.
Execution-based evidence is A-tier. Test results, console output. Show the exact test that now fails and passes, using pseudocode.
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.
04 同仓库更多 Skills
shop-design
Lantern Shop's colours, type and shelf-card layout.
ship-brief
Turns a request into a build brief, opens the pull request and merges it once review passes.
reviewing
Lantern Shop's own way of reviewing a change.
drafting
Drafts a short plan before any work starts.
setup
Use when the session start says "This folder isn't set up for Wheelhouse yet", that setup is part-way through, that setup's journal couldn't be read, or that Wheelhouse was removed from this folder; and when the Captain asks to set up Wheelhouse, carry on with setup, or remove Wheelhouse from a project.
review-standards
For Wheelhouse's build steps: review a change against the repository's documented coding standards and a fixed list of code smells.