关于 commit
commit 是引导 git 变更审查、逻辑分组、确认和依次提交的 Skill,适合需要创建规范提交并避免混入无关变更的开发者及编码 Agent。
主要功能
- 01检查 git 状态并审阅差异
- 02按关联内容分组文件
- 03提交前征求确认
- 04使用 Conventional Commits 格式
- 05确认提交并汇报结果
适用场景
- 01准备涉及多个文件的功能提交
- 02将文档变更与代码分开提交
- 03经确认创建提交且不推送
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ ghalex/ skills --skill commit安装后在 Claude Code 中输入/commit确认已加载。
附带文件README.md
详细介绍
即将创建 git 提交。请按以下步骤操作:
-
检查 git 状态:
- 运行
git status,查看所有未暂存和已暂存的文件 - 告诉我哪些文件发生了更改
- 运行
-
检查更改:
- 运行
git diff,查看所有已修改文件的实际更改 - 分析所有更改,了解修改内容
- 运行
-
按相关更改对文件分组:
- 分析更改,并将文件分组成逻辑清晰的提交
- 分组标准:
- 将实现同一功能的文件放在一起
- UI 组件单独提交,Redux 更改另行提交
- 文档更新与代码更改分开
- 按用途对配置文件(package.json、.md 文件)分组
- 相关的 Agent 文件(.agents/)放在一起
- 示例:
- 第 1 组:
simple-signup-form.tsx(新增 UI 组件) - 第 2 组:
CLAUDE.md、redux-agent.md、ui-agent.md(文档) - 第 3 组:
package.json(依赖或脚本更改) - 第 4 组:
store/users/api.ts、store/users/slice.ts、store/users/index.ts(Redux 模块)
- 第 1 组:
-
展示分组计划:
- 展示建议的分组,并征求确认
- 格式:
Commit 1: feat(ui): add simple signup form - src/components/custom/simple-signup-form.tsx Commit 2: docs: add redux and ui agent instructions - .agents/redux-agent.md - .agents/ui-agent.md - CLAUDE.md Commit 3: chore: add lint:file script to package.json - package.json - 等待我批准或提出调整
-
依次创建提交: 对每个已批准的分组:
- 仅对该组中的文件运行
git add <files> - 按照 Conventional Commit 格式编写有意义的提交信息:
- 格式:
type(scope): description - 类型:feat、fix、refactor、docs、style、test、chore
- 首行控制在 72 个字符以内
- 格式:
- 使用生成的提交信息运行
git commit -m "message" - 运行
git log -1确认提交
- 仅对该组中的文件运行
-
最终摘要:
- 运行
git log -<n>,其中 n = 创建的提交数量 - 向我展示创建的所有提交
- 运行
Conventional Commit 示例:
feat(ui): add simple signup form with Field componentsfeat(redux): add user preferences state managementfix(auth): prevent duplicate loading states in slicesdocs: update CLAUDE.md with redux-agent instructionsdocs(agents): add ui-agent workflow documentationrefactor(auth): improve token validation logicchore: add lint:file script to package.jsonstyle(ui): update button component spacing
重要规则:
- 绝不要在同一提交中包含无关文件
- 创建提交前务必征求确认
- 除非我明确要求,否则不要推送到远程
- 如果只有一个逻辑分组,则创建单个提交
评论
支持 Markdown