Sentry 提交规范
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @org-02qudk26/commit-zh。
技能介绍
要解决什么问题
团队一旦采用 Sentry 或类似 issue 驱动的工作流,提交消息就不再是「改了啥」一句话,而是 changelog、审阅和自动关单 的共同输入。格式不统一时,历史难以检索、合并后 issue 关不掉或误关,AI 辅助提交也缺少统一署名方式。
技能如何工作
本技能把 Sentry 提交消息规范 固化成可执行的写作规则,覆盖从分支到页脚的完整链路。
- 分支前置:在功能分支上提交;若在
main/master,先建分支,命名形如feat/add-user-auth、fix/null-pointer-error。 - 标题行:必填
type,可选scope;主题用祈使句、现在时,首字母大写、无句号,建议 ≤70 字符;单行总长 ≤100 字符。 - 类型表:
feat/fix/ref/perf/docs/test/build/ci/chore/style/meta/license等,与常见 Conventional Commits 扩展一致。 - 正文:写 what 与 why,不写实现细节;说明动机,必要时对比改前行为。
- 页脚:
Fixes #123合并时关闭 issue;Refs #123仅关联。变更主要由编码代理生成时,页脚加Co-Authored-By,且不在主题或正文里写「AI 生成」类文案。
适用边界
规范针对 Sentry 项目语境 与上述类型体系;若团队已绑定其他 commitlint 规则,需对照合并。原则仍是:每次提交单一、可独立审阅,提交后仓库可工作——技能不会替你做原子化拆分,只约束消息形态。
使用场景
- 在 Sentry 关联仓库里改完 bug,要写带 `Fixes #编号` 页脚、类型为 fix 的提交再提 PR
- 编码代理生成大部分 diff,需要在页脚加 Co-Authored-By,且主题行不出现 AI 字样
- 误在 main 上开发时,先按 `feat/` 或 `fix/` 建分支,再按类型表写 ≤70 字祈使句主题
- 做无行为变化的重构,用 ref 类型并写正文说明动机与改前对比,便于单独审阅
适合人员
- 维护接入 Sentry issue 工作流的开源项目、合并提交需正确关单的贡献者
- 负责发版说明或 changelog、希望 git 历史按 feat/fix/docs 等类型可检索的维护者
- 日常用 Claude Code 等代理改代码、又需符合团队 Sentry 提交格式的工程师
- 审阅 PR 时检查主题祈使句、正文 what/why 与 Fixes/Refs 是否一致的 code reviewer