开发与工程

writing-pr:PR 标题与描述撰写规范

一套让审阅者第一屏就看懂变更形状的 PR 撰写规范:Conventional Commits 标题、证据驱动的正文和必填的本地验证章节。

58/ 100
推荐

整体可靠,存在已披露的局限;按说明试用并保留回滚路径。

查看评分依据 ↓
可直接使用于
Codex · Claude Code
Star 数
★ 8.7k
最近更新
1 天前
License
Apache-2.0
pull-requestcode-reviewconventional-commitsgh-cli
+3technical-writingmermaiddeveloper-workflow

这个 Skill 能做什么,适合哪些场景?

writing-pr 是 tester-army/e2e 仓库内 10 个内部技能之一,位于 .dev/skills/writing-pr/SKILL.md,标记为 internal。它规范如何为该仓库撰写 PR 标题和正文:标题遵循 Conventional Commits 并与 squash-merge 后的提交一致,正文用简短要点、mermaid 图、代码引用和前后对比表格呈现,且必须包含一个「Verified」章节说明本地验证情况。它还列出应当省略的内容(CI 可报告的检查、中间历史、空 checklist)和应避免的 AI 写作痕迹(unslop 检查)。这是面向该仓库贡献流程的文档型技能,不含脚本。

  • 按该仓库约定生成 Conventional Commits 风格的 PR 标题(含 ! 破坏性变更标记)
  • 把 PR 正文组织为要点 + mermaid 流程图 + 带语言标签的代码块 + 文件行号引用
  • 为视觉改动和性能基准生成 before/after 表格,为修复类 PR 生成 | main | this branch | 对照表
  • 强制写入 ## Verified 章节,首行声明是否本地运行过,并说明用 gh 2.99+ --attach 上传截图/视频
  • 对成稿执行「unslop」语气检查,清除 'This PR introduces…'、'comprehensive' 等套话
  • 明确省略中间重构历史、diff 逐行复述和无要求的 checklist
适合
  • 向 tester-army/e2e 提交修复,需要按仓库惯例写清 bug 与修复对照及本地验证证据的贡献者
  • 提交影响 runner 流程或引擎钩子的架构改动,需要 mermaid 图和前后架构对比
  • 提交性能优化,需要以目标分支为基准的 before/after 基准表格
  • 提交纯文档或仅 CI 改动,需要如实声明 'Ran it locally: no' 并给出理由
  • 想让 AI 起草的 PR 描述去除营销腔套话,用干净的工程语气定稿
不适合
  • 非 e2e 仓库的贡献:规范明确绑定该仓库的 squash-merge 流程、verify 技能和路径约定,直接搬到其他仓库需要改写
  • 没有本地运行或验证条件的用户:技能要求每个 PR 提供真实验证证据,不提供虚假保证的话术
  • 只想自动生成通用 PR 文案、不关心审阅证据的场景:它是一份严格的编辑规范,不是文案生成器

如何安装这个 Skill?

使用前请注意
  • 该技能为内部仓库定制(internal: true),包含 squash-merge、suiteVersion、verify 技能等本仓库专有约定,直接移植到其他仓库会产生不适配。
  • 引用的 ../verify/SKILL.md 与 unslop 技能文件未在本次证据中出现,使用前应确认这些路径存在。
  • 建议的 gh --attach 行为依赖 gh 2.99+,低版本环境需自行核实。
  • 纯英文写作指导,无中文支持。
  • 静态审查,未执行任何验证流程。
开始前你需要
Agent 需要具备
  • Shell / 命令行
  • 网络访问
  • 本地文件系统
需要预先安装
  • GitHub CLI (gh 2.99+ for media uploads)

源材料未给出单独安装此技能的命令。它是 tester-army/e2e 仓库内的内部技能,通过克隆仓库获得:

git clone https://github.com/tester-army/e2e

README 只描述了 e2e 测试框架本身的安装(npx e2e init),未提供把 writing-pr 技能安装到 Claude Code 或其他 Agent Skills 客户端的步骤,此处不作臆测。

如何使用这个 Skill?

试试这样说

安装后,把下面任意一句发给 Agent 即可触发:

  • 按 writing-pr 规范为这次 runner prepare hook 的修复起草 PR 标题和正文,包含 Verified 章节
  • 帮我把这个 PR 描述改写掉 'comprehensive'、'ensures' 之类的套话,改成要点加证据的格式
  • 这次改动改变了 replay 流程,帮我画一个 mermaid 图放进 PR 正文
  • 这个修复在本地跑过了,帮我组织 bug 和修复的 before/after 表格以及 gh --attach 命令

技能由「正在撰写或编辑 PR 标题或正文」这一情境触发(description 原文即如此)。流程是:先用 Conventional Commits 起标题,正文写少量要点并附证据(图、代码引用、对比表),再补 ## Verified 章节。上传媒体用:

gh pr edit <pr> --body-file body.md --attach ./main.png --attach ./branch.png --attach ./video.webm

正文里用 ![after](./after.png) 引用图片,gh 会重写路径;视频不要写进正文,附件会自动追加为播放器。定稿前运行同仓库的 unslop 技能做语气检查。

这个 Skill 有哪些优点和局限?

优点
  • 规则非常具体可执行,含可直接复用的 Markdown 模板(Verified、基准表、mermaid 图)
  • 对 AI 常见的写作毛病(套话、加粗标签、破折号、凑数三要点)有针对性检查清单
  • 区分必须写的证据(Verified)和应省略的内容,边界清晰
局限
  • 标记为 internal 且深度绑定 e2e 仓库的流程(squash-merge、verify 技能、路径约定),跨仓库复用需改写
  • 没有脚本或自动化,全部是人工/AI 遵循的文字规范
  • 强制的 Verified 章节和本地运行要求对无法本地验证的贡献者是负担

这个 Skill 与同类方案有什么区别?

与相关 Skills 并排比较;分数均按同一 FSRS 标准得出。

Skill FS 评分 Star 数 最近更新 License
writing-pr:PR 标题与描述撰写规范 本页 58 · 推荐 ★ 8.7k 1 天前 Apache-2.0
Ship a PR(e2e 仓库 PR 交付流程) 59 · 推荐 ★ 8.7k 1 天前 Apache-2.0
CodeRabbit 代码审查 57 · 谨慎使用 ★ 188 4 天前 MIT
RenderCV PR 审查助手 55 · 谨慎使用 ★ 18k 6 个月前 MIT
Codex Pull Request 编辑器 ✓ OpenAI · 官方 50 · 谨慎使用 ★ 128k 3 天前 Apache-2.0

源材料未将其与具体竞品对比,但提到需搭配同仓库的 verify 技能(本地验证)和 unslop 技能(语气检查),三者是配套关系。

FollowSkills 如何评估这个 Skill?

FollowSkills 评估 · FSRS-2.0
推荐
58/ 100 五分制 2.9 / 5
1信任安全20 / 25 · 4.0/5

该技能是纯写作指导,不执行命令、不请求权限、无外部副作用或敏感数据处理;唯一的外部交互是建议用 gh CLI 上传图片/视频,流程透明。扣分点:没有可验证的来源归属(发布者未认证),且未讨论粘贴内容到 PR 可能外泄的信息边界。

2可靠稳定13 / 20 · 3.3/5

指令自洽、结构清晰(标题/正文/Verified/模板),模板可直接套用,gh --attach 用法描述具体。扣分点:引用的 ../verify/SKILL.md 与 unslop 技能文件不在本证据中,无法确认路径存在;纯文本技能无异常输入处理概念,仅能静态确认'基本合理'。

3适用触发8 / 15 · 2.7/5

触发条件明确(写或编辑 PR 标题/正文时),YAML description 与内容匹配,误触发风险低。扣分点:标记 internal: true,规则高度绑定本仓库约定(squash-merge、suiteVersion、verify 技能),对其他仓库不适用;无中文支持;依赖 GitHub/gh 与图片上传,未声明非适用范围。

4规范维护9 / 15 · 3.0/5

文档分层良好:先原则后细节,模板和反模式(Leave out、Voice)齐全,frontmatter 元数据存在。扣分点:技能本身无版本号或变更记录,维护责任未在技能文件内说明,unslop 引用路径(../../../.claude/skills/)跨目录且未在证据中出现,属于隐藏假设。

5有效结果5 / 15 · 1.7/5

对写 PR 这一任务提供了具体、可操作的格式与内容规则,比通用写作指导有边际价值。扣分点:静态审查无法验证产出是否可直接使用;部分规则(如 gh 2.99+ --attach 行为、squash-merge 标题约定)依赖外部事实,未在本证据中复现。

6证据核验3 / 10 · 1.5/5

技能的核心主张(gh --attach 重写路径、仓库合并惯例)在提供的文件中无独立佐证。仓库其他材料(CI 工作流、SECURITY.md)与该技能自身主张关联薄弱。静态审查限制下,只能给出低分。

1 2 3 4 5 6

点击维度查看打分理由

评估于 2026年10月10日 审查版本 449fa93670ee 评估证据[1][2][3][4][5][6][7][8][9][10]

证据充分度:低 — 主要依赖静态检查、作者材料或有限演示;适合发现线索,不适合做高风险决策。

查看完整评分方法 →

常见问题

这是给 e2e 仓库之外使用的吗?
不是主要场景。它标记 internal,规则绑定 e2e 的 squash-merge 流程和内部技能引用,其他仓库只能借鉴其结构,需自行调整。
PR 涉及纯文档或 CI,怎么满足 Verified 要求?
首行写 'Ran it locally: no - <why>',源材料给出的可接受理由包括文档错字、仅 CI 改动、没有对应的设备。
需要哪些工具?
需要 gh CLI 且版本 2.99 以上才能用 --attach 上传媒体;另外规则要求运行 unslop 技能,该技能在同仓库 .claude/skills/unslop/ 下。
视频怎么放进 PR?
不要在正文写视频路径。把视频作为 --attach 附件传入,gh 会把它们追加到 PR 末尾并渲染为播放器。

同仓库的其他 Skills

均来自 tester-army/e2e

开发与工程

Ship a PR(e2e 仓库 PR 交付流程)

把 tester-army/e2e 仓库中已完成的工作,交付成一个人类无需对抗 CI 和机器人评论就能审查的 PR:跑检查、验证、新上下文自审、开 PR,并一路盯到打上 Ready for Human Review 标签。

★ 8.7k FS 59 推荐 1 天前
开发与工程

babysit — PR 自动值守技能

自动推动一个开放 PR 解决冲突、回复评审机器人、修复 CI,直到全绿并打上"Ready for Human Review"标签,把机器能清的障碍全部清完。

★ 8.7k FS 54 谨慎使用 1 天前
写作与内容

e2e 文档写作规范技能

为 e2e 文档站编写、精简和重构指南页面时,自动套用一套以读者浏览习惯为中心的写作与瘦身规范。

★ 8.7k FS 54 谨慎使用 1 天前
开发与工程

e2e Verify —— 端到端变更验证技能

用真实 CLI 对测试底座和基准应用跑真实验证,为每一处改动留下可看见的证据,而不是只说"编译通过了"。

★ 8.7k FS 64 推荐 1 天前
开发与工程

unbox-ai — AI Agent 追踪分析 CLI

在命令行里分析 AI agent 的追踪文件,不用去读几兆字节的原始 JSON,就能查明 agent 为什么慢、为什么贵。

★ 8.7k FS 54 谨慎使用 1 天前
写作与内容

Unslop 文风去AI味技能

扫描并改写文本中的AI写作痕迹,同时注入真实的人类声音,让输出读起来像人写的。(description 中标注 Must always apply,即应始终生效。)

★ 8.7k FS 49 谨慎使用 1 天前
开发与工程

e2e Playground 验证技能

在声称 playground 改动可用之前,用 e2e 启动、驱动并截图取证验证 apps/testbed 测试应用。

★ 8.7k FS 59 推荐 1 天前
开发与工程

Create Verification Skill(e2e 验证技能生成器)

为你的项目自动生成一个 verify-<app> 验证技能,让任何编码智能体能像真实用户一样启动应用、驱动功能、留存证据并做 bug bash。

★ 8.7k FS 54 谨慎使用 1 天前
开发与工程

e2e 智能体端到端测试

用自然语言目标驱动浏览器与移动端 UI 测试,混合 agent 步骤与精确定位器断言,并带重放缓存降低模型成本。

★ 8.7k FS 52 谨慎使用 1 天前

相关 Skills