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
相关推荐
OsDepK几秒前
AudioSplit音频多轨免费分离工具即将发布
ide·git·python·音视频·集成学习
jiayong2315 分钟前
Git 常见错误与详细解决方案
大数据·git·elasticsearch
jiayong231 小时前
Git 分支命名、区别、联系与顺序关系说明
大数据·git·elasticsearch
无风听海2 小时前
Git 对象存储模型深度解析
git
展翅飞翔的小王2 小时前
速查】Git 常用提交流程 + 强制用远端覆盖本地
git
C137的本贾尼2 小时前
分支管理(一):创建、切换与合并,体验“平行宇宙”
git
jiayong232 小时前
常用 Git 命令详解
大数据·git·elasticsearch
weixin_386468963 小时前
openharmony 6.0编译rk3568过程记录
c语言·c++·git·python·vim·harmonyos·openharmony
C137的本贾尼4 小时前
初识Git:告别“报告_final_v2.docx”的噩梦
git
梦梦代码精5 小时前
LikeShop开源多端商城系统:半年使用记录
git·uni-app·github