| name | git-commit |
| description | 仅用 Git 分析改动并自动生成 conventional commit 信息(可选 emoji);必要时建议拆分提交,默认运行本地 Git 钩子(可 --no-verify 跳过) |
| disable-model-invocation | true |
| allowed-tools | Read(**), Exec(git status, git diff, git add, git restore --staged, git commit, git rev-parse, git config), Write(.git/COMMIT_EDITMSG) |
Claude Command: Commit (Git-only)
该命令在不依赖任何包管理器/构建工具的前提下,仅通过 Git:
- 读取改动(staged/unstaged)
- 判断是否需要拆分为多次提交
- 为每个提交生成 Conventional Commits 风格的信息(可选 emoji)
- 按需执行
git add 与 git commit(默认运行本地 Git 钩子;可 --no-verify 跳过)
Usage
/git-commit
/git-commit --no-verify
/git-commit --emoji
/git-commit --all --signoff
/git-commit --amend
/git-commit --scope ui --type feat --emoji
Options
--no-verify:跳过本地 Git 钩子(pre-commit/commit-msg 等)。
--all:当暂存区为空时,自动 git add -A 将所有改动纳入本次提交。
--amend:在不创建新提交的情况下修补上一次提交(保持提交作者与时间,除非本地 Git 配置另有指定)。
--signoff:附加 Signed-off-by 行(遵循 DCO 流程时使用)。
--emoji:在提交信息中包含 emoji 前缀(省略则使用纯文本)。
--scope <scope>:指定提交作用域(如 ui、docs、api),写入消息头部。
--type <type>:强制提交类型(如 feat、fix、docs 等),覆盖自动判断。
注:如框架不支持交互式确认,可在 front-matter 中开启 confirm: true 以避免误操作。
What This Command Does
-
仓库/分支校验
- 通过
git rev-parse --is-inside-work-tree 判断是否位于 Git 仓库。
- 读取当前分支/HEAD 状态;如处于 rebase/merge 冲突状态,先提示处理冲突后再继续。
-
改动检测
- 用
git status --porcelain 与 git diff 获取已暂存与未暂存的改动。
- 若已暂存文件为 0:
- 若传入
--all → 执行 git add -A。
- 否则提示你选择:继续仅分析未暂存改动并给出建议,或取消命令后手动分组暂存。
-
拆分建议(Split Heuristics)
- 按关注点、文件模式、改动类型聚类(示例:源代码 vs 文档、测试;不同目录/包;新增 vs 删除)。
- 若检测到多组独立变更或 diff 规模过大(如 > 300 行 / 跨多个顶级目录),建议拆分提交,并给出每一组的 pathspec(便于后续执行
git add <paths>)。
-
提交信息生成(Conventional 规范,可选 Emoji)
- 自动推断
type(feat/fix/docs/refactor/test/chore/perf/style/ci/revert …)与可选 scope。
- 生成消息头:
[<emoji>] <type>(<scope>)?: <subject>(首行 ≤ 72 字符,祈使语气,仅在使用 --emoji 时包含 emoji)。
- 生成消息体:
- 必须在 subject 之后空一行。
- 使用列表格式,每项以
- 开头。
- 每项必须使用动词开头的祈使句(如 "add…"、"fix…"、"update…")。
- 禁止使用冒号分隔的格式(如
"Feature: description"、"Impl: content")。
- 说明变更的动机、实现要点或影响范围(3 项以内为宜)。
- 生成消息脚注(如有):
- 必须在 Body 之后空一行。
- BREAKING CHANGE:若存在破坏性变更,必须包含
BREAKING CHANGE: <description>,或在类型后添加感叹号(如 feat!:)。
- 其它脚注采用 git trailer 格式(如
Closes #123、Refs: #456、Reviewed-by: Name)。
- 根据 Git 历史提交的主要语言选择提交信息语言。优先检查最近提交主题(例如
git log -n 50 --pretty=%s)判断中文/英文;若无法判断,则回退到仓库主要语言或英文。
- 将草稿写入
.git/COMMIT_EDITMSG,并用于 git commit。
-
执行提交
- 单提交场景:
git commit [-S] [--no-verify] [-s] -F .git/COMMIT_EDITMSG
- 多提交场景(如接受拆分建议):按分组给出
git add <paths> && git commit ... 的明确指令;若允许执行则逐一完成。
-
安全回滚
- 如误暂存,可用
git restore --staged <paths> 撤回暂存(命令会给出指令,不修改文件内容)。
Best Practices for Commits
- Atomic commits:一次提交只做一件事,便于回溯与审阅。
- 先分组再提交:按目录/模块/功能点拆分。
- 清晰主题:首行 ≤ 72 字符,祈使语气。
- 正文含上下文:说明动机、方案、影响范围(禁止冒号分隔格式)。
- 遵循 Conventional Commits:
<type>(<scope>): <subject>。
Type 与 Emoji 映射(使用 --emoji 时)
- ✨
feat:新增功能
- 🐛
fix:缺陷修复(含 🔥 删除代码/文件、🚑️ 紧急修复、👽️ 适配外部 API 变更、🔒️ 安全修复、🚨 解决告警、💚 修复 CI)
- 📝
docs:文档与注释
- 🎨
style:风格/格式(不改语义)
- ♻️
refactor:重构(不新增功能、不修缺陷)
- ⚡️
perf:性能优化
- ✅
test:新增/修复测试、快照
- 🔧
chore:构建/工具/杂务(合并分支、更新配置、发布标记、依赖 pin、.gitignore 等)
- 👷
ci:CI/CD 配置与脚本
- ⏪️
revert:回滚提交
- 💥
feat:破坏性变更(BREAKING CHANGE: 段落中说明)
若传入 --type/--scope,将覆盖自动推断。
仅在指定 --emoji 标志时才会包含 emoji。
Guidelines for Splitting Commits
- 不同关注点:互不相关的功能/模块改动应拆分。
- 不同类型:不要将
feat、fix、refactor 混在同一提交。
- 文件模式:源代码 vs 文档/测试/配置分组提交。
- 规模阈值:超大 diff(示例:>300 行或跨多个顶级目录)建议拆分。
- 可回滚性:确保每个提交可独立回退。
Examples
Good (使用 --emoji)
- ✨ feat(ui): add user authentication flow
- 🐛 fix(api): handle token refresh race condition
- 📝 docs: update API usage examples
- ♻️ refactor(core): extract retry logic into helper
- ✅ test: add unit tests for rate limiter
- 🔧 chore: update git hooks and repository settings
- ⏪️ revert: revert "feat(core): introduce streaming API"
Good (不使用 --emoji)
- feat(ui): add user authentication flow
- fix(api): handle token refresh race condition
- docs: update API usage examples
- refactor(core): extract retry logic into helper
- test: add unit tests for rate limiter
- chore: update git hooks and repository settings
- revert: revert "feat(core): introduce streaming API"
Good (包含 Body)
feat(auth): add OAuth2 login flow
- implement Google and GitHub third-party login
- add user authorization callback handling
- improve login state persistence logic
Closes #42
fix(ui): fix button spacing on mobile devices
- adjust button padding to fit small screens
- fix styling issues on iOS Safari
- optimize touch target size
Good (包含 BREAKING CHANGE)
feat(api)!: redesign authentication API
- migrate from session-based to JWT authentication
- update all endpoint signatures
- remove deprecated login methods
BREAKING CHANGE: authentication API has been completely redesigned, all clients must update their integration
Split Example
- `feat(types): add new type defs for payment method`
- `docs: update API docs for new types`
- `test: add unit tests for payment types`
- `fix: address linter warnings in new files` ←(如你的仓库有钩子报错)
Important Notes
- 仅使用 Git:不调用任何包管理器/构建命令(无
pnpm/npm/yarn 等)。
- 尊重钩子:默认执行本地 Git 钩子;使用
--no-verify 可跳过。
- 不改源码内容:命令只读写
.git/COMMIT_EDITMSG 与暂存区;不会直接编辑工作区文件。
- 安全提示:在 rebase/merge 冲突、detached HEAD 等状态下会先提示处理/确认再继续。
- 可审可控:如开启
confirm: true,每个实际 git add/git commit 步骤都会进行二次确认。