Pr

作者 mattpocockb0618bc436ad無授權條款收錄於 2026年10月8日更新於 2026年10月8日

Use when writing a PR body.

AI 產生的概覽

提供撰寫 PR 內文的範本與指引,包含摘要圖示、證據與合併風險。

功能
此技能提供 PR 內文的 Markdown 範本,包含三個部分:摘要、證據與合併風險。它說明如何用虛擬碼、呼叫樹、元件樹、檔案樹、Mermaid 圖或 diff 來呈現摘要,以及如何展示螢幕截圖或測試輸出等前後對照證據。它也說明如何將變更描述為單向門或雙向門,並說明其影響範圍。
適用情境
在草擬或組織 PR 內文時使用。適用於變更需要簡潔的視覺說明、具體的前後對照證據,以及合併風險評估的情境。
執行需求
不需要指令碼或工具,僅為指示性內容。它會引用 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 從公開儲存庫中收錄這些內容。

檢舉或申請下架