关于 commit
一项根据 Git 差异编写 Conventional Commits 的技能,面向需要规范提交的开发者,涵盖变更分类、消息撰写和安全提交步骤。
主要功能
- 01检查已暂存或未暂存的更改
- 02分类类型、范围和描述
- 03添加说明正文与问题页脚
- 04标记破坏性变更
- 05提交前检查机密信息
适用场景
- 01为已完成的更改编写提交消息
- 02将无关更改拆分为多个提交
- 03记录问题引用或破坏性变更
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ angusfretwell/ skills --skill commit安装后在 Claude Code 中输入/commit确认已加载。
详细介绍
所有提交都必须采用 Conventional Commits 格式:<type>(scope): <description>,后接可选的正文和页脚。
步骤
- 查看差异。 运行
git status和git diff --staged(如果没有暂存内容,则改用git diff)。 - 分类。 选择
type(feat、fix、docs、style、refactor、perf、test、build、ci、chore、revert)、scope(受影响的范围;如果变更涉及面广,则省略)和description(一行祈使语气的描述,不超过 72 个字符)。这三项都必须对应差异中的具体变更。如果差异包含多个互不相关的变更,请分别提交。 - 编写提交信息。 组装主题行。如果变更的原因不言自明,则无需添加正文;否则添加正文,说明原因以及读者无法从差异中看出的内容。如果适用的问题编号,请添加页脚(
Closes: <id>、Refs: <id>)。使用!标明破坏性变更(feat(api)!: require verified email);如果需要解释破坏性变更,则添加BREAKING CHANGE:页脚。 - 提交。 暂存需要提交的文件——如果文件中含有秘密或凭据,请停止并标记。运行
git commit并让钩子正常运行;如果钩子失败,请修复原因或报告问题。
只有在用户明确要求时,才可重写共享历史记录或绕过检查——例如使用 --force、reset --hard、--no-verify 或编辑 git config。
评论
支持 Markdown