跳到主要内容

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工作流改进
ciCI/CD 配置相关
types类型定义修改
wip正在进行中的工作,开发中的提交(不建议合入主分支)

参考文档