Pr

作者 mattpocockb0618bc436ad无许可证收录于 2026年10月8日更新于 2026年10月8日

Use when writing a PR body.

AI 生成的概览

提供撰写拉取请求正文的模板与指导,包含摘要图示、证据与合并风险。

功能
该技能提供一个拉取请求正文的 Markdown 模板,包含三个部分:摘要、证据和合并风险。它说明如何用伪代码、调用树、组件树、文件树、Mermaid 图或 diff 来呈现摘要,以及如何展示截图或测试输出等前后对比证据。它还说明如何将变更描述为单向门或双向门,并说明其影响范围。
适用场景
在起草或组织拉取请求正文时使用。适用于变更需要简洁的视觉说明、具体的前后对比证据以及合并风险评估的场景。
运行要求
不需要脚本或工具,仅为说明性内容。它会引用 GLOSSARY.md 以使用用户的领域语言,模板中会用到 Mermaid 图和 diff。

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 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:
text
<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 needed to answer the user's current question or the options to resolve the current discussion point.

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.

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.

来源与署名

来源:mattpocock/skills位于skills/engineering/pr提交b0618bc

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架