在团队协作开发过程中,规范的 Git 提交信息不仅能提高代码维护的效率,还能让其他开发者更容易理解每次提交的目的和内容。下面是常用的 Git 提交信息类型及其详细说明。此外,还包括一些额外的提交类型,以便更全面地覆盖开发过程中可能遇到的场景。
1. 标准提交类型
-
feat:
git commit -m "feat: 新增用户登录功能"
- 用于提交新功能的开发或现有功能的修改。
- 示例:
feat: 增加用户注册功能
-
fix:
git commit -m "fix: 修复用户登录无法跳转主页的bug"
- 用于修复代码中的 bug。
- 示例:
fix: 修复登录验证错误
-
docs:
git commit -m "docs: 更新API文档"
- 用于提交与文档相关的变更,包括但不限于 API 文档、README、注释等。
- 示例:
docs: 更新项目README文件
-
style:
git commit -m "style: 格式化代码,删除多余空行"
- 用于提交不影响代码含义的变更,如格式调整、空白符、逗号、分号位置的变更等。
- 示例:
style: 统一代码格式
-
refactor:
git commit -m "refactor: 重构用户认证逻辑"
- 用于代码重构,既不涉及功能的添加,也不修复 bug。
- 示例:
refactor: 优化数据处理逻辑
-
perf:
git commit -m "perf: 提高页面加载速度"
- 用于提升性能的代码更改。
- 示例:
perf: 优化查询速度
-
test:
git commit -m "test: 增加用户注册功能的单元测试"
- 用于添加或修改现有测试用例。
- 示例:
test: 增加边界值测试
-
chore:
git commit -m "chore: 修改.gitignore文件"
- 用于日常杂项,不涉及源代码的变更,如构建流程、辅助工具、依赖库的变更等。
- 示例:
chore: 更新依赖包版本
2. 额外提交类型
除了以上的标准类型外,还有一些可以用于更细化的场景:
-
ci:
git commit -m "ci: 修复CI配置文件"
- 用于持续集成(CI)配置文件及脚本的变更,如 Jenkins、Travis 等。
- 示例:
ci: 配置CI自动化测试
-
build:
git commit -m "build: 更新webpack配置"
- 用于构建系统或外部依赖项的变更,如
webpack
配置、依赖项版本更新等。 - 示例:
build: 升级依赖到最新版本
- 用于构建系统或外部依赖项的变更,如
-
revert:
git commit -m "revert: 还原错误提交"
- 用于撤销之前的提交。
- 示例:
revert: 还原上次错误提交
-
merge:
git commit -m "merge: 合并feature-branch到master"
- 用于分支合并,特别是解决冲突的提交。
- 示例:
merge: 合并开发分支到主分支
-
wip:
git commit -m "wip: 工作进行中,未完成"
- 用于标识正在进行中的工作,还未完成的提交。
- 示例:
wip: 初步实现用户管理模块