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
相关推荐
weixin_4624462318 小时前
使用 git filter-repo 统一提交作者信息(修复常见逻辑问题)
git
化名三爷18 小时前
SSH 公钥设置
git·gitee·ssh·ssh公钥·git公钥
web守墓人19 小时前
【git】git基础用法指南
git
小肉包de20 小时前
本地项目第一次提交到远程仓库
git
酒书21 小时前
mac电脑idea更改git用户名和密码
git·macos·intellij-idea
学好statistics和DS1 天前
.git folder
git
神秘代码行者1 天前
Git Restore 命令教程
大数据·git·elasticsearch
yanlaifan1 天前
git命令删除一个分支中的指定commit
git
m0_471199631 天前
【git】略微解析一下 git cherry-pick 命令
git
wacpguo1 天前
Git 远程公共分支 到 本地个人分支
git