让 AI 按照 Sentry 规范自动编写 Git Commit 提交信息
解决提交信息混乱的问题:通过设定 Sentry 工业级提交规范,让 AI 自动生成包含类型、范围、正文及 Issue 索引的标准 Commit Message,并强制执行分支安全检查。
为什么需要这个技能
在多人协作的大型项目中,随意编写的提交信息(如 “fix bug” 或 “update”)会导致版本历史难以追溯。
本技能引入了 Sentry 的提交约定,要求 AI 在执行 git commit 前必须遵循特定的结构化格式。它不仅规范了 feat、fix 等类型标签,还加入了严格的分支安全逻辑——禁止直接在 main 或 master 分支提交,强制 AI 在提交前检查并引导用户创建特性分支,从而确保主干分支的绝对纯净。
适用场景
- 需要在团队中统一 Git 提交格式,以便于自动生成 Changelog。
- 希望 AI 在提交代码时自动关联 GitHub 或 Sentry 的 Issue 编号。
- 防止 AI 在误操作时直接将代码提交到生产主分支。
- 需要清晰记录 AI 协作贡献(Co-Authored-By)的场景。
核心工作流
- 分支安全检查:AI 首先执行
git branch --show-current。若处于main/master分支,将自动触发create-branch流程,确保代码提交在特性分支上。 - 构建标准化 Header:采用
<type>(<scope>): <subject>格式。- Type:如
feat(新功能)、fix(修复)、ref(重构)、perf(性能优化)等。 - Subject:使用祈使句、现在时,首字母大写,且不以句号结尾。
- Type:如
- 撰写 Body 与 Footer:
- Body:解释“做了什么”以及“为什么做”,而非“怎么做”。
- Footer:引用 Issue(如
Fixes SENTRY-1234),若由 AI 生成,则添加Co-Authored-By: Claude <noreply@anthropic.com>。
下载和安装
解压后将目录放入你的 AI 工具 skills 文件夹,重启工具后即可使用。具体路径参考内附的 USAGE.zh.md。
你可能还需要
暂无推荐