Git提交信息
Git 提交信息规范 (Conventional Commits)
一个好的 Git 提交信息能清晰记录项目的演变,方便团队协作和问题追溯。
基本结构
一个完整的提交信息包含三个部分:Header
(头部)、Body
(正文) 和 Footer
(页脚)。
<type>(<scope>): <subject><body><footer>
Header
(必需): 简明扼要地描述改动类型和内容。type
(类型): 强制性,说明提交的性质。feat
: 新增功能。fix
: 修复 Bug。docs
: 修改文档。style
: 格式调整,不影响代码运行。refactor
: 重构代码。test
: 新增或修改测试。chore
: 构建或辅助工具的变动。
scope
(范围): 可选,说明改动影响的模块。subject
(主题): 简短描述,使用祈使句,首字母小写,结尾无句号。
Body
(可选): 提供更详细的改动背景和原因。Footer
(可选): 用于说明不兼容的变更,或关联相关的 Issue。
实践案例
不规范的提交信息
fixed bug
- 问题:没有上下文,不知道修复了什么。
规范的提交信息
fix(auth): fix login button not redirecting to dashboardThe login button was not correctly redirecting authenticated users. This commit fixes the logic to ensure the redirect happens after a successful login.Closes #123
- 优点:
fix
: 明确是 Bug 修复。(auth)
: 表明影响认证模块。- 主体:描述了具体问题。
- 正文:解释了为什么修复以及如何修复。
Closes #123
: 关联了对应的 Issue。