git commit 提交信息规范

常见用法

复制代码
# 将暂存区内容提交到版本库, 进入 vi 命令界面输入提交信息
git commit

# 将某些已被跟踪的文件提交到版本库(包含工作区和版本库)
git commit [file1] [file2] [...]

# 将暂存区内容提交到版本库, 无需进入 vi 命令界面输入提交信息
git commit -m "message"

# 跳过 git add, 将所有已被跟踪的文件更改提交到版本库
git commit -am "message"

# 使用一次新的commit, 替代上一次提交
# 如果代码没有任何新变化, 则用来改写上一次commit的提交信息
git commit --amend -m "message"

约定格式

复制代码
// type和subject必需,scope、body、footer可选
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
1、type(必填)

commit提交类型,主要包含如下几种:

type 描述
feat 新增功能
fix 修复bug
merge 合并代码
ui 样式调整
refactor 重构(既不修复错误也不添加功能)
perf 优化相关,比如提升性能、体验
revert 回滚之前的commit
2、scope(选填)

commit 影响的范围, 可以是影响的文件名、模块名、组件名、国家等。

3、subject(必填)

commit的简短描述。

4、body(选填)

commit 具体修改内容, 可以分为多行。

5、footer

一些备注, 通常是 Breaking changes 或修复的 bug 的链接.

提交多行提交信息的方法

方法一(进入 vi 模式输入多行提交信息)
复制代码
# 进入 vim 命令界面
git commit

# 按下 i,进入 vim 的插入模式,将下面内容粘贴进入后,输入 :wq 回车即可
fix:修复购物车模块
1、修复用户无法添加购物车功能
2、修复购物车商品结算问题
方法二(命令行输入多行提交信息)
复制代码
# 第一步:输入第一行
git commit -m "fix:修复购物车模块

# 第二步:按下回车输入第二行、按下回车输入第三行 ...
1、修复用户无法加入购物功能

# 第三步:多行提交信息输入结束,尾部加上引号,回车完成提交操作
2、修复购物车商品结算问题"
方法三(粘贴提前写好的提交命令) ------推荐

提前在文本编辑器中写好准备执行的提交命令,复制粘贴到命令行中执行即可,如下所示:

复制代码
git commit -m "fix:用户模块、购物车模块
1、修复用户无法注册功能
2、修复购物车商品批量删除报错问题
3、修复积分商城支付成功后订单状态没有改变问题
"
相关推荐
毕设十刻1 小时前
基于Vue的考勤管理系统8n7j8(程序 + 源码 + 数据库 + 调试部署 + 开发环境配置),配套论文文档字数达万字以上,文末可获取,系统界面展示置于文末
前端·数据库·vue.js
合方圆~小文1 小时前
不同画面,三个镜头实时监控拍摄方案
数据结构·数据库·人工智能
ChrisitineTX2 小时前
凌晨突发Java并发问题:synchronized锁升级导致接口超时,排查过程全记录
java·数据库·oracle
极限实验室3 小时前
Easysearch 2.0.0 性能测试
数据库·性能优化
老华带你飞3 小时前
社团管理|基于Java社团管理系统(源码+数据库+文档)
java·数据库·vue.js·spring boot·后端
shayudiandian3 小时前
用LangChain打造你自己的智能问答系统
java·数据库·langchain
马克学长4 小时前
SSM特殊教育学校学生管理系统002k1(程序+源码+数据库+调试部署+开发环境)带论文文档1万字以上,文末可获取,系统界面在最后面
数据库·学生管理系统·特殊教育·ssm 框架
卿雪4 小时前
Redis 线程模型:Redis为什么这么快?Redis为什么引入多线程?
java·数据库·redis·sql·mysql·缓存·golang
梁萌5 小时前
MySQL中innerDB引擎的锁机制
数据库·mysql·索引·表锁·行锁
老华带你飞5 小时前
汽车销售|汽车报价|基于Java汽车销售系统(源码+数据库+文档)
java·开发语言·数据库·vue.js·spring boot·后端·汽车