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
相关推荐
蜡台2 小时前
Vue 中多项目的组件共用方案
前端·javascript·vue.js·git
剑飞的编程思维4 小时前
技术评审方法与流程全解析-如何做好技术评审
git·架构·个人开发·学习方法·技术美术·代码复审
OPMR5 小时前
【Git基础】从入门到入门——安装和远端链接
git
liu****5 小时前
5.git标签管理
c++·git·版本控制
新晨4377 小时前
Git跨分支文件恢复:如何将其他分支的内容安全拷贝到当前分支
前端·git
kishu_iOS&AI7 小时前
Git SSH + SourceTree篇
运维·git·ssh
Java小白,一起学习7 小时前
git提交格式(Conventional Commits 规范)
git
liu****7 小时前
linux上git推送内容到gitee上
c++·git·gitee·版本控制
华科大胡子7 小时前
Git + 云原生:如何管理K8s配置版本?
git
希夷小道7 小时前
gitru:一个由 Rust 打造的零依赖 Git 提交信息校验工具
git·rust