在团队开发中,Git 是一款不可或缺的版本控制工具。规范化的提交信息不仅能帮助团队快速理解每次代码变更的内容,还能提高协作效率。以下是常见的 Git 提交类型及其用途解析,并附上详细的提交信息示例。
1. feat (功能)
功能
表示新增功能,常用于记录新的产品功能或模块更新。
示例:
feat: 新增用户注册功能
- 支持用户通过邮箱注册
- 添加注册成功后的欢迎邮件功能
- 增加注册表单验证逻辑
2. fix (修复)
修复
表示修复错误或问题,通常用于解决 bug。
示例:
fix: 修复登录按钮点击无响应的问题
- 修正了事件绑定未生效的 bug
- 增加点击按钮后的状态反馈
- 测试覆盖率达到 100%
3. docs (文档)
文档
用于文档相关的修改,例如更新项目的 README 文件或 API 文档。
示例:
docs: 更新项目 README 文件
- 增加项目运行步骤说明
- 补充环境变量的配置示例
- 添加贡献指南
4. style (格式)
格式
指代码格式的调整,不影响代码逻辑和功能。
示例:
style: 调整代码缩进,统一为 2 空格
- 修改文件内所有缩进为统一格式
- 删除多余的空行
5. refactor (重构)
重构
对现有代码进行优化和改进,提升可读性、可维护性或性能,而不改变功能。
示例:
refactor: 优化用户信息查询逻辑
- 将用户查询逻辑抽象为独立的服务
- 减少重复代码,提升可维护性
- 添加单元测试覆盖新逻辑
6. chore (杂项)
杂项
记录构建过程或辅助工具的变动,例如更新依赖项或配置文件。
示例:
chore: 更新依赖包版本
- 升级 webpack 至 v5.0.0
- 替换 node-sass 为 dart-sass
- 修复因版本冲突导致的构建失败问题
7. revert (回滚)
回滚
撤销某次提交,恢复到之前的版本。
示例:
revert: 回滚提交 1234abcd,修复错误更新
- 恢复 feature 模块之前的状态
- 删除临时提交内容
8. perf (性能优化)
性能优化
用于性能相关的改进,例如提升执行速度或减少资源消耗。
示例:
perf: 优化首页加载速度
- 替换大图为延迟加载的小图
- 减少 API 请求数量
- 将 CSS 文件压缩至 20KB 以下
9. test (测试)
测试
测试相关的改动,包括新增测试用例或调整已有测试。
示例:
test: 增加单元测试覆盖用户注册功能
- 覆盖用户注册的正常和异常流程
- 修复部分未通过的旧测试用例
10. improvement (改进)
改进
对现有功能进行增强或优化。
示例:
improvement: 增强表单输入容错逻辑
- 支持空格和特殊字符的过滤
- 增加对用户输入的实时反馈
11. build (构建)
构建
涉及与项目构建相关的变动。
示例:
build: 修改构建脚本以支持多环境配置
- 增加本地和生产环境的区分
- 优化构建流程,减少无用文件
12. ci (持续集成)
持续集成(Continuous Integration)
与 CI 流程相关的改动,例如配置修改或构建问题修复。
示例:
ci: 修复 GitHub Actions 构建失败问题
- 调整 CI 脚本中的测试路径
- 增加对新分支的自动构建支持