type
status
date
slug
summary
tags
category
icon
password
1. Commit 信息的基本格式
2. 详细说明
2.1. type
(类型)
描述本次提交的性质,通常包括以下几类:
类型 | 描述 |
feat | 新功能(feature) |
fix | 修复 Bug |
docs | 文档(documentation)修改 |
style | 不影响代码逻辑的修改(如格式化、漏掉分号等) |
refactor | 代码重构(既不是新增功能也不是修复 Bug 的代码改动) |
test | 添加或修改测试 |
chore | 其他不修改源代码或测试的事务性更改(如构建脚本) |
perf | 提升性能 |
revert | 回滚某次提交 |
2.2. scope
(范围)
- 表明提交代码的影响范围,例如模块、功能或文件夹。
- 可选项,但在大型项目中建议加上。
示例:
feat(auth): add JWT authentication
fix(ui): correct button alignment
2.3. subject
(主题)
- 简明扼要地描述提交的改动。
- 建议使用 动词原形 开头(如 add、fix、update 等)。
- 避免句号结尾,保持风格简洁。
2.4. body
(正文,选填)
- 提供更详细的修改原因和实现细节。
- 解释代码修改的上下文,描述该改动的意义。
示例:
2.5. footer
(页脚,选填)
页脚通常用于:
- 关闭相关问题(例如
Closes #123
)。
- 影响的重大变更说明(如 BREAKING CHANGES)。
示例:
3. 实践中的示例
- 新功能:
- 修复 Bug:
- 文档更新:
- 性能优化:
- 回滚提交:
- Author:Serendipity
- URL:https://serendipity565.netlify.app//article/git%20commit%20%E8%A7%84%E8%8C%83
- Copyright:All articles in this blog, except for special statements, adopt BY-NC-SA agreement. Please indicate the source!