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: 撤销上一个提交

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

相关推荐
高山莫衣5 小时前
git rebase多次触发冲突
大数据·git·elasticsearch
码农藏经阁5 小时前
工作中常用的Git操作命令(一)
git
kobe_OKOK_6 小时前
【团队开发】git 操作流程
git·elasticsearch·团队开发
码农垦荒笔记6 小时前
Git 安装闭坑指南(仅 Windows 环境)
windows·git
CC码码16 小时前
管理你的多个 Git 密钥(多平台多账号)
git·gitlab·github
CC码码16 小时前
管理你的多个 Git 密钥(单平台多账号)
git·gitlab·github
大卫小东(Sheldon)16 小时前
GIM 1.5发布了! 支持Windows系统了
git·ai·rust
flying jiang16 小时前
将大仓库拆分为多个小仓库
git
李boyang10 天前
Git(四):远程操作
git
荻野泽溪10 天前
Git新建分支并同步到远程
git