关于 pr
pr 是用于撰写简洁英文拉取请求正文的技能。它指导作者选择合适的可视化形式说明改动,并补充证据与合并风险。
主要功能
- 01组织简洁的 PR 摘要
- 02选择图表或代码式示意
- 03提供改动前后证据
- 04说明合并风险和影响范围
适用场景
- 01起草英文 PR 正文
- 02以图示解释代码或界面改动
- 03记录测试证据与变更风险
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ hu3rror/ my-skills --skill pr安装后在 Claude Code 中输入/pr确认已加载。
附带文件agents/openai.yamlCREDITS.md
详细介绍
使用此模板撰写 PR 正文:
## 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>
语言
使用英语撰写 PR 正文。
章节
省略所有开场白,正文保持简短。使用 GLOSSARY.md 中的用户领域术语。
摘要
选择能清楚说明重点的最精简呈现方式。
- 使用伪代码展示逻辑或算法:
on(save)
if content is unchanged
return cached result
write new content
return fresh result
- 使用调用树展示运行时控制流:
submitForm
createSession
persistPrompt
launchAgent
navigateToSession
- 使用组件树展示 UI 结构,并包含重要的状态和模块边界:
<SessionPage> (apps/example/src/routes/session.tsx)
useSessionEvents()
<SessionToolbar>
<RunSkillButton> (packages/ui)
- 使用简明的文件树展示文件职责或大范围重构:
src/
├── commands/ # parses user actions
├── sessions/ # owns session state
└── transport/ # sends API requests
- 使用 Mermaid 展示组件交互、控制流或数据流:
sequenceDiagram
participant User
participant UI
participant Daemon
User->>UI: choose command
UI->>Daemon: send expanded prompt
Daemon-->>UI: stream result
- 当重点是变更内容,且周边结构已存在时,使用
diff。根据主题匹配 diff 结构。
对于组件变更:
<SessionPage>
useSessionEvents()
<SessionToolbar>
+ <RunSkillButton />
<SessionTimeline>
+ <SkillResultCard />
对于文件布局变更:
src/
├── commands/
+│ └── show-me.ts # expands the slash command
├── sessions/
-└── transport.ts
+└── transport/
+ ├── client.ts
+ └── stream.ts
对于调用树或调用栈变更:
submitForm
createSession
persistPrompt
+ expandSkillMention
launchAgent
- navigateToSession
+ navigateToSession
+ subscribeToEvents
对于状态或控制流变更:
on(save)
- write content
+ if content is unchanged
+ return cached result
+ write new content
+ invalidate cache
- 当大部分内容都是新增的、省略上下文会掩盖归属或顺序,或用户需要可复制的目标结构时,展示完整代码块:
function expandSkill(command: string): string {
const skillName = command.slice(1);
return `use the ${skillName} skill`;
}
指南
将每个可视化内容放在它所支持的简短说明旁边。只保留回答用户当前问题或解决当前讨论事项所需的调用、文件、属性、状态和边界。
可以使用其中一种,也可以使用多种;不太可能全部用上。请酌情选择,避免给用户造成信息负担。
证据
提供变更有效的具体证据。展示变更前后的情况。
如果环境已配置好,截图是 S 级证据,尤其适用于视觉变更。
基于执行的证据属于 A 级证据,例如测试结果、控制台输出。使用伪代码展示现在失败和通过的确切测试。
合并风险
说明这是单向门还是双向门。双向门可以走回头路,但单向门不行。容易回滚的 PR 风险较低。涉及破坏性操作或难以撤销的决策的变更属于单向门。
影响范围是此 PR 引入的变更可能造成的影响或涉及的范围。考虑所有可能性,例如布局偏移、对使用方造成的故障、移动端响应式布局等。
评论
支持 Markdown