Commit - Git 提交消息生成器

分析已暂存的更改，并生成符合语义化规范的提交消息。

命令

工作流程

步骤 1：提交前检查

# 验证当前目录是否为 Git 仓库
git rev-parse --is-inside-work-tree

# 检查是否存在已暂存的更改
git diff --staged --quiet

# 获取已暂存的文件列表
git diff --staged --name-only

若无已暂存的更改：运行 git status，提示用户先暂存更改。

步骤 2：分析已暂存的更改

git diff --staged
git diff --staged --stat

分析重点：

1. 变更类型识别

   • 新增文件 → feat
   • 修改文件 → 基于内容判断
   • 删除文件 → refactor 或 chore

2. 语义化类型分类

   • feat：新增功能/特性
   • fix：修复 Bug
   • refactor：不改变行为的代码重构
   • docs：仅文档更新
   • style：格式调整、空白字符变更等
   • test：测试相关更改
   • chore：构建、依赖项、工具链等杂项任务
   • perf：性能优化
   • ci：CI/CD 相关配置或脚本变更
   • build：构建系统变更

3. 作用域（Scope）识别

   • 从文件路径中提取：例如 src/auth/login.ts → 作用域为 auth

步骤 3：生成提交消息

格式：

(): 

[可选正文]

[可选页脚]

规则：

• 主题（subject）使用祈使语气：用 “add” 而非 “added”
• 主题末尾不加句号
• 主题长度不超过 50 字符
• 正文每行最多 72 字符
• 页脚示例：BREAKING CHANGE:、Closes #123、Fixes #456

示例：

feat(auth): add JWT token refresh mechanism

fix(payment): handle duplicate callback correctly

Payment callback was processing duplicates due to missing idempotency
check. Added unique constraint on (order_id, callback_id).

Fixes #234

refactor(db)!: migrate from MySQL to PostgreSQL

BREAKING CHANGE: Database migration required.

步骤 4：执行提交

# 使用生成的消息提交（作者信息为全局 Git 用户配置）
git commit -m "type(scope): subject" [-m "optional body"]

或多行消息可使用 heredoc 方式：

git commit -m "$(cat <<'EOF'
type(scope): subject

optional body
EOF
)"

验证提交结果：

git log -1 --oneline
git show HEAD --stat

最佳实践

应当（DO）：

• ✅ 在生成提交消息前，分析所有已暂存的更改
• ✅ 使用祈使语气（如 “add”，而非 “added”）
• ✅ 主题控制在 50 字符以内
• ✅ 对复杂更改补充正文说明
• ✅ 在适用时引用对应 issue（如 Closes #123）
• ✅ 将相关联的更改合并至单次提交中

禁止（DON'T）：

• ❌ 在无已暂存更改的情况下提交
• ❌ 将无关的更改混入同一提交
• ❌ 使用过去式动词
• ❌ 主题末尾添加句号
• ❌ 在提交消息中包含敏感信息
• ❌ 跳过 pre-commit 钩子（除非用户明确要求跳过）

边界情况处理

无已暂存更改

git status
# 提示："No staged changes. Would you like to stage all changes?"

空仓库（首次提交）

git rev-parse HEAD 2>/dev/null || git commit -m "chore: initial commit"

差异过大（超过 500 行）

git diff --staged --stat
git diff --staged --unified=1
# 建议将更改拆分为多个提交

存在合并冲突

git status | grep "both modified"
git commit -m "merge: resolve conflicts in "

钩子集成

• pre-commit：自动触发执行
• commit-msg：自动触发执行
• 若钩子执行失败：报告错误并建议修复方案
• 仅当用户明确请求时，才允许通过 --no-verify 参数绕过钩子校验