Git Commit 规范
提示
不规范的 Git Commit 信息给代码更新追踪溯源增加了麻烦,编写清晰、有意义的 Git 提交信息对于项目的维护和协作至关重要
这里收集一些常用的 Git Commit 模板参考,必要时可以使用一些工具来 约束 Git Commit 信息
Git Commit 模板
Git Commit 信息通常包含以下几个部分
<type>(<scope>): <subject>
其中:
type: 描述提交类型scope: 描述提交范围,可选subject: 提交的简短描述
type 常用类型如下表所示
| 类型 | 描述 |
|---|---|
| feat | 新增功能 |
| fix | 修复 bug |
| docs | 文档或注释修改 |
| style | 代码样式调整(不影响逻辑) |
| refactor | 代码重构 |
| perf | 性能优化 |
| revert | 回滚,撤销更改 |
| test | 添加或修改测试 |
| chore | 构建流程、依赖管理等杂项更改 |
| workflow | 工作流改进 |
| ci | CI/CD 配置相关 |
| types | 类型定义修改 |
| wip | 正在进行中的工作,开发中的提交(不建议合入主分支) |