开发与工程

PR 提交流程规范

规范 SkillHub 项目的 PR 标题、提交信息与提交前检查清单,帮助团队统一提交流程。

40/ 100
不推荐

当前收益不足以覆盖风险或不确定性。

查看评分依据 ↓
可直接使用于
ChatGPT · Codex · Claude Code
Star 数
★ 5.2k
最近更新
3 天前
License
Apache-2.0
git-workflowcommit-conventionspr-checklistcode-review
+1conventional-commits

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

该技能为 SkillHub 项目的 GitHub 拉取请求提供标准化指导,涵盖 PR 标题格式、提交信息约定和提交前检查清单。它定义了六种提交类型(feat、fix、docs、test、refactor、chore)及适用范围,并列出常用模块作为 scope。技能还包含应遵循的检查命令(如 make test-backend-app)和 PR 描述结构模板,确保每次提交都经过验证并遵循架构约束。

该技能提供了一套规则和模板,用于:根据变更类型和范围格式化 PR 标题;使用约定式提交风格编写提交信息;运行提交前检查命令(如 make test-backend-app、make typecheck-web、make generate-api);构建 PR 描述,涵盖 What、Why、How、Testing、Impact 五个部分;并在审查时引用 AGENTS.md 规则,检查依赖方向符合干净架构。

适合
  • 当开发者准备提交一个功能或修复 bug 的 PR 时,根据变更类型和模块格式化标题。
  • 在推送提交之前,确保提交信息遵循约定式提交风格,每个提交只包含一个逻辑变更。
  • 在创建 PR 前运行检查命令,验证后端测试、前端类型检查和 API 生成是否正常。
  • 当 API 或架构有变更时,更新相关设计文档并确保生成文件已提交。
  • 当审查他人 PR 时,使用该技能提供的检查点:验证依赖方向、API 类型是否重新生成等。

如何安装这个 Skill?

使用前请注意
  • 发布者身份未经验证,来源可信度有限
  • 技能仅提供指导,不包含执行或回滚机制,需用户自行确认
  • 未提及中文支持或网络可达性,可能不适合中国用户环境
开始前你需要
Agent 需要具备
  • Shell / 命令行

该技能的安装方式未在源码中明确说明。作为 SkillHub 仓库的一部分,它位于 .agents/skills/pr-submission/SKILL.md,可通过克隆 iflytek/skillhub 仓库获取,并将其中的技能目录复制到你的 Agent 技能目录。

通用方式:手动安装到 Claude Code(macOS / Linux)
tmp="$(mktemp -d)"
git clone --depth 1 https://github.com/iflytek/skillhub.git "$tmp"
mkdir -p ~/.claude/skills
cp -R "$tmp/.agents/skills/pr-submission" ~/.claude/skills/
rm -rf "$tmp"

根据源仓库地址和 Skill 路径自动生成,只复制这个 Skill 的文件夹。如果上文有作者提供的安装方式,请优先按作者说明操作;想只在当前项目中使用,把 ~/.claude/skills 换成项目里的 .claude/skills。

如何使用这个 Skill?

在准备或审查 PR 时,按以下步骤操作:1. 确定变更范围(功能、修复等);2. 根据类型和模块格式化 PR 标题和提交信息;3. 运行检查命令(如 make test-backend-app);4. 编写包含 What/Why/How/Testing/Impact 的 PR 描述。可参考示例:标题格式为 feat(auth): add local account login with password reset。

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

优点
  • 明确了 PR 标题和提交信息的格式,易于学习和统一。
  • 提供了具体的检查命令,可自动验证测试和生成步骤。
  • 包含 PR 描述结构模板,帮助作者完整覆盖关键信息。
  • 审查时强调遵守 AGENTS.md 和干净架构规则,有利于代码质量。
局限
  • 仅适用于 SkillHub 仓库,没有泛化到通用项目。
  • 检查命令(如 make generate-api)是项目特定的,在其他环境中可能需要调整。
  • 技能本身不自动执行任何操作,只是提供指导,需要开发者手动遵循。
  • 未提供该技能的自动化测试或验证,依赖用户自觉。

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

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

Skill FS 评分 Star 数 最近更新 License
PR 提交流程规范 本页 40 · 不推荐 ★ 5.2k 3 天前 Apache-2.0
Ship a PR(e2e 仓库 PR 交付流程) 59 · 推荐 ★ 8.7k 1 天前 Apache-2.0
writing-pr:PR 标题与描述撰写规范 58 · 推荐 ★ 8.7k 1 天前 Apache-2.0
CE Commit 提交助手 51 · 谨慎使用 ★ 25k 3 天前 MIT
PR 保姆:持续监控拉取请求直至合并 47 · 谨慎使用 ★ 98k 3 天前 Apache-2.0

FollowSkills 如何评估这个 Skill?

FollowSkills 评估 · FSRS-2.0
不推荐
40/ 100 五分制 2.0 / 5
上游仓库在本次评估后已有新提交;当前评分仍对应所示审查版本,可能尚未覆盖最新改动。
1信任安全13 / 25 · 2.6/5

技能本身是文档型指导,不涉及外部副作用或敏感数据处理,因此没有严重风险,但缺少用户确认机制和回滚步骤,且发布者身份未经验证,无法完全保证来源可信。

2可靠稳定5 / 20 · 1.3/5

命令和检查清单自洽,但依赖仓库中的脚本和 CI,未提供独立测试;静态评审无法验证关键路径,错误处理描述有限,因此分数低。

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

目标场景明确(PR 提交流程),但未声明能力边界和非适用场景,触发条件仅为描述,欠缺精确语义;环境适配(中文支持和网络)未提及。

4规范维护8 / 15 · 2.7/5

结构清晰,有类型表、示例和检查清单,但缺少安装说明、版本信息、变更日志和维护责任说明,license 已在 frontmatter 声明但未提供详细使用文档。

5有效结果4 / 15 · 1.3/5

能指导用户完成 PR 提交,但缺乏实际输出验证和比较优势证据;价值相对手工操作有限,因此分数低。

6证据核验2 / 10 · 1.0/5

无独立可复现的测试或第三方验证,仅依赖仓库内文件;静态评审无法确认实际执行,因此分数低。

1 2 3 4 5 6

点击维度查看打分理由

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

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

查看完整评分方法 →

常见问题

该技能是否适用于非 SkillHub 的项目?
不完全适用,因为它依赖 SkillHub 项目的特定命令和模块结构。但核心的约定式提交和 PR 描述模板可以借鉴到其他项目。
如果我忘记运行检查命令会怎样?
技能只是提供检查清单,不会强制执行。未运行可能导致 CI 失败或代码质量问题,因此建议严格遵循。
技能在执行时需要网络连接吗?
不需要,它只提供文本指导。实际检查命令可能需要本地环境(如 Node.js、Java),但不涉及网络。
能否自动生成 PR 描述?
不能,技能只提供模板,需要用户手动编写描述内容。

同仓库的其他 Skills

均来自 iflytek/skillhub

相关 Skills