git gitee github等系列提交备注规范,提交规范(实用)


<新功能|bug修复|文档改动|格式化|重构|测试代码>: (影响范围) <主题> # 解释为什么要做这些改动?issue #?
一、type 类型

type 包含以下几种:【统一全部变成小写】
增加了这些
feat、feature : 新增 feature 新功能
fix: 修复 bug
docs: 仅仅修改了文档,比如 README, CHANGELOG, CONTRIBUTE等等
style: 仅仅修改了空格、格式缩进、逗号等等,不改变代码逻辑
refactor: 代码重构,没有加新功能或者修复 bug
perf: 优化相关,比如提升性能、体验
test: 测试用例,包括单元测试、集成测试等
chore: 改变构建流程、或者增加依赖库、工具等
revert: 回滚到上一个版本 撤销上一次的commit

add:新功能
update:更新
del:移除文件
build:构建工具或构建过程的变动,如:webpack升级、gulp替换为webpack等
二、description 描述

影响范围(可选)
用于说明此次提交影响到的范围,如数据层、控制层、视图层等。

主题
用于本次提交的主题简短说明,可含主要模块的相关说明。

issue(可选)

所关联的issue。

另一版本的git提交规范

首先,规范没有好坏,只有适不适合,这是种习惯,为了可读性、方便查询代码提交记录

commit message格式

<type>(<scope>): <subject>

type(必须)

用于说明git commit的类别,只允许使用下面的标识。

feat:新功能(feature)。

fix/to:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。

fix:产生diff并自动修复此问题。适合于一次提交直接修复问题
to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
docs:文档(documentation)。

style:格式(不影响代码运行的变动)。

refactor:重构(即不是新增功能,也不是修改bug的代码变动)。

perf:优化相关,比如提升性能、体验。

test:增加测试。

chore:构建过程或辅助工具的变动。

revert:回滚到上一个版本。

merge:代码合并。

sync:同步主线或分支的Bug。

scope(可选)

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

例如在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。如果你的修改影响了不止一个scope,你可以使用*代替。

subject(必须)

subject是commit目的的简短描述,不超过50个字符。

git gitee github等系列提交备注规范,提交规范(实用)相关推荐

  1. Git基础:第七、八章 Git提交规范Github/Gitee(github资料附录表)

    文章目录 第七章 Git提交规范 7.1 Commit Message 7.1.1 自动化校验commit message 7.2 Author & Committer 7.3 Changed ...

  2. 代码管理工具系列介绍 Git的使用 和 Git ,Github,Gitlab,Gitee,Gitpod的区别

    Git Git 不仅仅是个版本控制系统,它也是个内容管理系统(CMS),工作管理系统等. 如果你是一个具有使用 SVN 背景的人,你需要做一定的思想转换,来适应 Git 提供的一些概念和特征. Git ...

  3. Git提交代码注释信息规范-相关命令汇总

    - Git提交代码注释信息规范- git commit -m "提交类型+代码总结"- 提交类型:1. feat: 修改/增加新功能2. fix: 修改bug/功能代码的变更3. ...

  4. Windows下git连接GitHub(github.com)、码市(coding.net)、码云(gitee.com)

    1.安装git与注册 git下载安装及简单使用请参考:传送门 在三个网站分别进行注册,本人比较懒,使用相同的用户名.邮箱及密码进行注册 2.设置公钥 git生成公钥钥,使用如下命令: $ ssh-ke ...

  5. 07.GitHub实战系列~7.Git之VS2013团队开发(如果不想了解git命令直接学这篇即可)...

    GitHub实战系列汇总:http://www.cnblogs.com/dunitian/p/5038719.html ---------------------------------------- ...

  6. 【Git】Git兼容GitHub和Gitee的问题与对策

    帮助文章指引 HTTP 413 curl 22 The requested URL returned error: 413 Request Entity Too Large. ERROR: Repos ...

  7. ssh协议(git和github gitee 之间的传输协议)

    全面概述Gitee和GitHub生成/添加SSH公钥 SSH公钥就是git生成的一个给gitee 或者 github认证的锁,可以安全传输数据的那种 git本地仓库 $ mkdir gitrep // ...

  8. Git命令及集成IDEA、Gitee/GitHub/GitLab

    Git 一.Git 常用命令 命令名称 作用 git config --global user.name 用户名 设置用户签名 git config --global user.email 邮箱 设置 ...

  9. Git、Github、Gitee、GitLab学习笔记

    文章目录 Git.Github.Gitee.GitLab学习笔记 前言 一.Git 1.Git概述 2.Git基本操作介绍 2.1 安装&卸载 2.2 启动 3.Git的基本使用 3.1 GI ...

最新文章

  1. jquery获取元素宽高
  2. 如何有效地进行代码 Review?
  3. oracle pl sql 抛出例外
  4. C++ 二进制文件写操作
  5. 【vue】vue +element 搭建项目,要求既支持pc端又支持移动端
  6. 50个常用的sql语句
  7. 原来有这么多的国产“自主研发”早就把开源项目抄哭了
  8. 分享15款堪称神器却鲜为人知的软件和网站
  9. caffe入门学习(5):绘制网络结构图
  10. VMware vCenter Server 7.0 U2b/6.7 U3n/6.5 U3p 修复高危安全漏洞
  11. ccleaner激活后又要注册_ccleaner如何激活? ccleaner注册激活图文步骤
  12. lvds 共模电感_初识共模电感 - yi394517286的博客 - 与非博客 - 与非网
  13. 机器学习:公式推导与代码实现全书代码!
  14. 解决WPS在Linux下字体缺失
  15. oracle cve 漏洞,CVE安全漏洞的理解
  16. linux驱动主从设备号,在 Linux 设备管理中,除了设备类型外,内核还需要一对被称为主从设备号的参数,才能唯一标识一个设备。( )相同的设备使用相同的驱动程序...
  17. 购买了虚拟主机还要云服务器,购买了虚拟主机还要云服务器
  18. 针对刀具磨损的日志读取的曲线分析(一维高斯滤波及波形拟合)
  19. 数据结构——图书管理系统
  20. 【计算机科学与技术】信息论笔记:合集

热门文章

  1. 计算机劣质电源危害,电源选购不合理带来的几个严重后果一
  2. [数分笔记]Dedekind切割定理的证明
  3. 电商企业办公桌面云方案
  4. 几款市面上常见的区块链APP,你知道多少?
  5. VC error C4430错误解决方法
  6. css样式顶掉important和important的使用注意点
  7. Winform从入门到精通(30)——MonthCalendar(史上最全)
  8. BP神经网络(推荐)
  9. 《惢客创业日记》2020.09.14(周一)结束王者游戏的调研
  10. MYSQL按月对收款金额进行统计