Git Commit Guide
by @leavesfly
Type
Instruction
Platforms
Claude CodeClaude.aiAPI
Best for
developerqa
Resources
Git Commit Guide
Git 提交规范（Conventional Commits）
How it works
Git 提交规范技能包
遵循 Conventional Commits 规范，提升团队协作质量和代码可维护性。
提交消息格式
<type>(<scope>): <subject>
<body>
<footer>
基本格式
<类型>[可选作用域]: <描述>
示例：
feat(api): 添加用户认证接口
fix(database): 修复连接池泄漏问题
docs(readme): 更新安装说明
提交类型（Type）
| 类型 | 说明 | 示例 |
|---|---|---|
| feat | 新功能 | feat(user): 添加用户注册功能 |
| fix | Bug 修复 | fix(login): 修复密码验证错误 |
| docs | 文档变更 | docs(api): 更新 API 文档 |
| style | 代码格式（不影响逻辑） | style: 统一代码缩进 |
| refactor | 重构（不是新功能或修复） | refactor(auth): 优化认证逻辑 |
| perf | 性能优化 | perf(query): 优化数据库查询 |
| test | 测试相关 | test(user): 添加用户模块单元测试 |
| build | 构建系统或外部依赖 | build: 升级 Spring Boot 到 3.0 |
| ci | CI 配置文件和脚本 | ci: 添加 GitHub Actions 配置 |
| chore | 其他不修改源代码的变更 | chore: 更新 .gitignore |
| revert | 回滚之前的提交 | revert: 回滚 feat(api): xxx |
作用域（Scope）
作用域表示影响的模块或组件，可选但建议添加。
常见作用域示例：
user- 用户模块auth- 认证模块api- API 接口database- 数据库config- 配置ui- 用户界面
描述（Subject）
- 使用祈使句，现在时态
- 首字母小写
- 结尾不加句号
- 简洁明了，控制在 50 字符以内
✅ 好的描述：
feat(api): 添加用户注册接口
fix(login): 修复密码加密错误
❌ 不好的描述：
feat(api): 添加了用户注册接口。
fix: 修复bug
正文（Body）
详细说明变更的动机和与之前行为的对比。
格式要求：
- 使用祈使句，现在时态
- 应该说明"为什么"而不是"是什么"
- 每行不超过 72 字符
示例：
fix(auth): 修复 JWT Token 验证失败问题
之前使用的签名算法与解析算法不一致，导致 Token 验证总是失败。
现在统一使用 HS256 算法，并添加了算法一致性检查。
页脚（Footer）
用于记录不兼容变更和关闭的 Issue。
Breaking Changes
BREAKING CHANGE: 删除了 v1 版本的 API
请迁移到 v2 版本，详见迁移指南。
关闭 Issue
Closes #123
Closes #456, #789
完整示例
示例 1：新功能
feat(user): 添加用户头像上传功能
支持上传 JPG、PNG 格式的图片，最大 5MB。
自动生成缩略图并存储到 OSS。
Closes #234
示例 2：Bug 修复
fix(order): 修复订单金额计算错误
在计算优惠券折扣时未考虑最小金额限制，
导致部分订单金额为负数。现已添加金额验证。
Closes #567
示例 3：破坏性变更
feat(api): 重构用户认证 API
BREAKING CHANGE: 移除了 /api/v1/auth 端点
请使用新的 /api/v2/auth 端点，返回格式已变更。
详见 API 文档：https://example.com/api-docs
Closes #890
Git Hooks 配置
Commit Message 验证
创建 `.git/h...