关于 commit
面向开发者的提交信息编写技能,规定分支检查、消息格式和隐私要求,也说明如何划分变更及添加问题和破坏性变更页脚。
主要功能
- 01提交前检查分支
- 02规定消息类型与格式
- 03指导划分连贯变更
- 04提交内容隐私要求
- 05问题与破坏性变更页脚
适用场景
- 01在功能分支准备提交
- 02为重构选择消息类型
- 03在提交中记录问题引用
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ getsentry/ skills --skill commit安装后在 Claude Code 中输入/commit确认已加载。
详细介绍
Sentry 提交消息
提交前
git branch --show-current
如果当前分支是 main 或 master,请创建一个功能分支,除非用户明确要求直接提交。重新检查分支;如果仍是 main 或 master,请停止。
每次只提交一个完整、可独立审查的更改。
消息规则
使用:
<type>(<scope>): <subject>
<optional body>
<optional footer>
- 作用域为可选项。对于破坏性更改,在
:前添加!。 - 主题使用祈使语气和现在时;首字母大写,省略句末句号,且不超过 70 个字符。
- 每行不超过 100 个字符。
- 仅在有帮助时编写正文。说明更改内容和原因;如有帮助,也说明之前的行为或动机。
- 切勿包含客户或组织名称、用户邮箱、支持工单内容、机密或个人身份信息。请改为描述技术症状。
允许的类型:feat、fix、ref、perf、docs、test、build、
ci、chore、style、meta、license 和 revert。
对于不改变行为的重构,使用 ref;对于不改变逻辑的格式调整,使用 style;对于仓库元数据,使用 meta。
页脚
- 合并时,
Fixes <issue>会关闭对应问题。 Refs <issue>会关联对应问题,但不会关闭它。- 对于破坏性更改,添加
BREAKING CHANGE: <impact>。
创建提交
段落和页脚使用单独的 -m 参数。切勿在提交消息中使用字面量 \n 序列,也不要打开交互式编辑器。
git commit -m "fix(api): Handle null response in user endpoint" \
-m "Return 404 when the user API finds a deleted account." \
-m "Fixes SENTRY-5678"
评论
支持 Markdown