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
相关推荐
Tingjct12 小时前
git/gdb指令
大数据·git·elasticsearch
谷哥的小弟13 小时前
(最新版)Git&GitHub实操图文详解教程(03)—Git工作原理
git·github·版本控制·工作原理·git工作原理
devilnumber14 小时前
idea中git的commit弹出框改为工具框
git
向日的葵00616 小时前
大模型技术之git(第四章)
git
火车叼位16 小时前
当 Git Pull 把工作区搅成一锅粥:理解 Merge 与 Abort
git
向日的葵00617 小时前
大模型技术之git(第六章)
git
澈20720 小时前
Git入门指南:核心概念与实用操作
大数据·git·搜索引擎
Naisu Xu20 小时前
Mac上安装Homebrew、Git、Python等环境记录
git·python·macos·终端·brew
摸鱼仙人~21 小时前
Learn Git Branching:提交的技巧
git
say_fall21 小时前
Git完全入门指南-从概念到实战掌握版本控制的核心
linux·运维·服务器·git·学习