Git commit 通用提交消息规范

在使用Git进行版本控制时,可以采用一种通用的提交消息规范,以提高团队协作和代码审查的效率。一种常见的提交消息规范是使用 "Conventional Commits" 规范,它使用一些预定义的关键字来标识提交的类型和目的。以下是一些常见的关键字和它们的含义:

  1. feat: 新功能(feature):表示提交引入了新的功能、功能改进或添加新的功能点。

  2. fix: 修复(fix):表示提交修复了一个Bug或解决了一个问题。

  3. refactor: 重构(refactor):表示提交对代码进行了重构,但没有添加新功能或修复Bug。

  4. docs: 文档(docs):表示提交更新了文档,例如README文件、文档注释等。

  5. style: 格式(style):表示提交对代码的格式进行了修改,如缩进、空格、格式化等,但没有改变代码的逻辑。

  6. chore: 杂务(chore):表示提交执行了与构建、工具、依赖管理等相关的杂务任务。

  7. test: 测试(test):表示提交添加或修改了测试用例。

  8. perf: 性能(perf):表示提交对代码进行了性能优化。

  9. ci: 持续集成(ci):表示提交对持续集成配置进行了修改。

  10. revert: 撤销(revert):表示提交撤销了之前的提交。

示例提交消息:

复制代码
feat: 添加用户注册功能
fix: 修复登录页面的输入验证问题
docs: 更新README文件
style: 格式化代码
chore: 更新依赖版本
test: 添加用户管理模块的单元测试
perf: 优化数据库查询性能
ci: 更新CI配置
revert: 撤销上一个提交

采用这种规范的提交消息有助于清晰地了解每个提交的目的,提高代码审查的效率,追踪项目的变更历史,以及生成有意义的版本发布日志。你可以根据团队的实际需求自定义提交消息规范,并使用工具或脚本来验证和自动化检查提交消息的格式。

相关推荐
ShineWinsu3 小时前
对于Git:基础操作的超详细保姆级解析
linux·c++·git·面试·备份·管理·版本控制器
沉迷...4 小时前
Git skip-worktree 使用笔记(本地忽略配置文件)
javascript·git
解道Jdon6 小时前
JDK 27发布:紧凑对象头、G1默认、量子安全TLS
ide·windows·git·svn·eclipse·github·visual studio
天天喝旺仔9 小时前
Git 内部原理深度解析:从 blob/tree/commit 对象到 packfile 与垃圾回收
数据结构·数据库·git·算法·哈希
艾莉丝努力练剑9 小时前
【Git:综合复盘】Git 原理与使用
大数据·人工智能·git·elasticsearch·面试
ShineWinsu1 天前
对于Git:远程操作的超详细保姆级解析
linux·git·gitee·github·远程仓库·分布式版本控制系统·远程操作
梦帮科技1 天前
从 Guest 到 Platinum:Prompt 配额、API Key 与访问控制的安全闭环
javascript·git·架构·node.js·reactjs·html5·visual studio
zho_uzhou2 天前
Git入门概念
git
爱奥尼欧2 天前
【Git】远程分支删了本地还在、两个分支历史不相干?两招故障排解
开发语言·git
Java后端的Ai之路2 天前
Git冲突完整排查与实战:本地修改覆盖报错到成功推送全流程复盘
开发语言·人工智能·git·python·pop