Git提交备注规范(Git commit comment specification)

为了开发团队规范管理以及统计Commit做数据分析,需要对每次code commit定义一些规范:

前缀简写

全称

详细描述

示例

feat

新功能(feature)

新增一个功能

feat: 添加用户登录功能

fix

修补bug

修复一个bug

fix: 修正用户登录时密码验证错误的问题

docs

文档(documentation)

添加或修改文档

docs: 更新用户手册中关于登录的说明

style

格式(不影响代码运行的变动)

调整代码格式,如空格、缩进等

style: 统一代码缩进为4个空格

refactor

重构(即不是新增功能,也不是修改bug的代码变动)

重构代码,提高可读性、可维护性等

refactor: 优化用户登录逻辑,提高代码可读性

test

增加测试

添加新的测试用例或修改现有测试

test: 为用户登录功能添加单元测试

chore

构建过程或辅助工具的变动

更改构建脚本、配置文件等

chore: 更新构建脚本以支持新版本的依赖库

perf

性能优化

提高代码性能,如减少内存使用、优化算法等

perf: 优化用户登录流程,减少数据库查询次数

deps

依赖更新

更新项目依赖的库或工具

deps: 升级Spring框架到最新版本

revert

撤销之前的提交

撤销之前的某个或某些提交

revert: 撤销关于用户登录密码验证错误的修复

merge

合并分支

合并其他分支的更改到当前分支

merge: 将feature/login分支合并到main分支

wip

工作进行中(Work In Progress)

表明提交是临时性的,仍在开发中

wip: 开始开发用户注册功能(未完成)

conflict

解决冲突

解决合并冲突后的提交

conflict: 解决main分支与feature/login分支的合并冲突

示例详解

  1. feat: 添加用户登录功能
    • 详细描述:实现了一个用户登录功能,包括用户名和密码的验证。
    • 示例代码:添加了一个新的登录接口和相应的处理逻辑。
  2. fix: 修正用户登录时密码验证错误的问题
    • 详细描述:在之前的版本中,用户登录时密码验证存在错误,导致无法正确登录。
    • 示例代码:修改了密码验证的逻辑,确保正确验证用户密码。
  3. docs: 更新用户手册中关于登录的说明
    • 详细描述:更新了用户手册中关于登录功能的说明,确保用户能够正确理解和使用。
    • 示例文档:更新了用户手册的PDF文件,添加了登录功能的操作步骤和注意事项。
  4. style: 统一代码缩进为4个空格
    • 详细描述:将代码中的缩进统一为4个空格,提高代码的可读性。
    • 示例代码:使用IDE的代码格式化功能,将项目中所有文件的缩进统一为4个空格。
  5. refactor: 优化用户登录逻辑,提高代码可读性
    • 详细描述:对用户登录逻辑进行了重构,提高了代码的可读性和可维护性。
    • 示例代码:将登录逻辑拆分为多个函数,每个函数负责一个具体的步骤。
  6. test: 为用户登录功能添加单元测试
    • 详细描述:为用户登录功能添加了单元测试,确保功能的正确性和稳定性。
    • 示例测试代码:编写了一个单元测试类,测试了用户登录的不同场景和边界情况。
  7. chore: 更新构建脚本以支持新版本的依赖库
    • 详细描述:更新了项目的构建脚本,以支持新版本的依赖库。
    • 示例脚本:修改了pom.xml文件,更新了依赖库的版本号。
  8. perf: 优化用户登录流程,减少数据库查询次数
    • 详细描述:对用户登录流程进行了性能优化,减少了数据库查询次数,提高了登录速度。
    • 示例代码:在登录逻辑中添加了缓存机制,减少了数据库查询次数。
  9. deps: 升级Spring框架到最新版本
    • 详细描述:将项目中的Spring框架升级到最新版本,以获取新的功能和性能改进。
    • 示例代码:修改了pom.xml文件,将Spring框架的版本号升级到最新版本。
  10. revert: 撤销关于用户登录密码验证错误的修复
    • 详细描述:由于之前的修复引入了新的问题,因此撤销了该修复。
    • 示例代码:使用git revert命令撤销了之前的修复提交。
  11. merge: 将feature/login分支合并到main分支
    • 详细描述:将feature/login分支中的更改合并到main分支中。
    • 示例操作:使用git merge命令将feature/login分支合并到main分支。
  12. wip: 开始开发用户注册功能(未完成)
    • 详细描述:开始开发用户注册功能,但尚未完成。
    • 示例代码:添加了一些初步的注册功能代码和注释。
  13. conflict: 解决main分支与feature/login分支的合并冲突
    • 详细描述:在合并main分支和feature/login分支时发生了冲突,进行了解决。
    • 示例操作:手动解决了合并冲突,并提交了解决后的代码。