Git commit提交规范

引言

使用git管理代码的同行,我们经常能看到其他人代码提交时的备注写的过长,有的看不懂,有的太过间接,本文旨在简单说明git commit提交的规范,规范提交内容。

git commit template

提交格式<type>(<scope>): <subject>

格式对应说<commit类型>(影响范围可选): 具体描述

举例 fix(DAO): 修复xxBug。

type

|--------------|---------------------------|
| 类型 | 说明 |
| feat | 新功能 |
| fix | 修补bug |
| docs | 文档 |
| style | 格式(不影响代码运行的变动) |
| refactor | 重构(即不是新增功能,也不是修改bug的代码变动) |
| test | 增加测试 |
| chore | 构建过程或辅助工具的变动 |
| perf | 性能优化 |
| build | 打包 |
| ci | 持续集成 |

scope(可选)

scope用于说明 commit 影响的范围,根据不同项目有不同层次描述。若没有特殊规定,也可以描述影响的哪些功能等。

subject

subject是 commit 目的的简短描述,不超过50个字符。

  • 以动词开头,使用第一人称现在时,比如change
  • 结尾不加标点符号
  • 第一个字母小写

栗子

sql 复制代码
fix(mybatis):修复sql查询bug
相关推荐
HAPPY酷2 小时前
git配置及使用
git
sg_knight2 小时前
IntelliJ IDEA 实用插件:GitToolBox 使用指南
java·ide·git·intellij-idea·插件·gittoolbox
青靴4 小时前
Git Hooks 实现 CI/CD 进阶实践 -- 根据实际需求添加功能
git·elasticsearch·ci/cd
LiuYaoheng5 小时前
Git配置SSH Key到GitHub的详细教程
git·ssh·github
x***B4115 小时前
Git数据分析实战
git·数据挖掘·数据分析
健康平安的活着7 小时前
gitflow的实战操作案例【经典实操】
git
1***s6329 小时前
Git混合现实开发
git·mr
q***R30810 小时前
Git日志
git
草莓熊Lotso11 小时前
Git 本地操作进阶:版本回退、撤销修改与文件删除全攻略
java·javascript·c++·人工智能·git·python·网络协议