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
相关推荐
虾说羊7 小时前
git连接远程仓库并拉去推送以及克隆命令
git
IT~狂男9 小时前
GIT 实战命令操作大全,代码变动,推动,修改备注,撤销(篇幅一)
git
前端拿破轮9 小时前
从0到1搭一个monorepo项目(一)
前端·javascript·git
消失的旧时光-194310 小时前
git的 Rebase
git
风禾万里19 小时前
Git怎么管理软件版本(代码,模型,配置等)
git
默默coding的程序猿21 小时前
3.git的分支携带问题是什么?怎么解决?
java·git·python·svn·gitee·github·intellij-idea
天地人-神君1 天前
将.idea取消git托管
java·git·intellij-idea
Zach_yuan1 天前
版本控制器Git
linux·git
唐青枫1 天前
Git 提交时神秘的 create mode 100644 到底是什么?一文告诉你答案!
git
春生野草1 天前
Git-git stash与分支管理
git