IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> 开发工具 -> GIT 提交说明的规范 -> 正文阅读

[开发工具]GIT 提交说明的规范

通过 GIT 提交代码的时候,必须要写提交说明,否则就无法提交

如果我们所有人能够按照一套规范去写提交说明(Commit Message),那我们阅读 Pull Request 的效率就会很高, 参考了 Github 上的开源项目及部分公司的提交规范,总结出以下规范。

规范是所有人默认的一套规定,并不是强制要求,以公司的规范为首要,如果有问题,请留言。。。

部分提交代码说明参考

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

Commit Message 的标准格式

Commit Message 的组成部分:Header、Body、Footer

[Issues][Module]<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

Header 介绍

Header 的组成:Issues、Module、type、scope、subject

① Issues(可选)

Issues 我们可以理解成我们平时的 需求单 或者 修改单 的单号,一般指的是社区使用人员提出的问题编号

② Module(可选)

当前的修改主要修改了项目中的哪个模块,此处的定义不是很严格

③ type(必须)

用于说明此次提交主要做了哪种类型的处理,主要有以下这些类型

type说明
feat增加了新功能或者新的需求(A new feautre)
fix修复了 bug 或者问题(fix a bug)
improvement对当前功能的改进(An improvement to current feature)
docs对文档进行了修改或者增加
style格式化的变动,不影响代码的逻辑
refactor对当前的需求的实现方式进行重构,不影响期望的结果
perf提高性能的修改
test增加或修改测试用例
build构建工具或外部依赖包的修改,比如更新依赖包的版本等
ci持续集成的配置文件或脚本的修改
chore杂项,其他不修改源代码或测试代码的修改
revert撤销某次提交

④ scope(可选)

此次提交的代码影响的范围,比如数据层、控制层、视图层等等

⑤ subject(必须)

此次提交的简短的描述

Body 介绍

Body:可以省略

Body 是对 subject 的补充,可以多行

Footer 介绍

Footer:可以省略

主要是一些关联 issue 的操作

提交示例

示例一:完成新的需求,需求单号为 208757,该需求可以让用户的积分推送到 kafka 的主题中

[208757][point][feat]: push customer's point to kafka

示例二:修改一个 bug,该 bug 产生在需求单 208756 中,对应的缺陷是 237405,该 bug 导致了部分数据丢失

[208756][user][fix]: fix bug which can make user's data lost

when user choose add address,some data will lost

#237405

或者

[208756][user][fix]: fix bug which can make user's data lost (#237405)
  开发工具 最新文章
Postman接口测试之Mock快速入门
ASCII码空格替换查表_最全ASCII码对照表0-2
如何使用 ssh 建立 socks 代理
Typora配合PicGo阿里云图床配置
SoapUI、Jmeter、Postman三种接口测试工具的
github用相对路径显示图片_GitHub 中 readm
Windows编译g2o及其g2o viewer
解决jupyter notebook无法连接/ jupyter连接
Git恢复到之前版本
VScode常用快捷键
上一篇文章      下一篇文章      查看所有文章
加:2021-11-29 16:30:44  更:2021-11-29 16:32:23 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年12日历 -2024/12/24 2:54:34-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码
数据统计