当前位置: 首页 > news >正文

Git提交规范

一. 修改类型

每个类型值都表示了不同的含义,类型值必须是以下的其中一个:

  • feat:提交新功能
  • fix:修复了bug
  • docs:只修改了文档
  • style:调整代码格式,未修改代码逻辑(比如修改空格、格式化、缺少分号等)
  • refactor:代码重构,既没修复bug也没有添加新功能
  • perf:性能优化,提高性能的代码更改
  • test:添加或修改代码测试
  • chore:对构建流程或辅助工具和依赖库(如文档生成等)的更改

二.代码回滚

代码回滚比较特殊,如果本次提交是为了恢复到之前的某个提交,那提交消息应该以“revert:”开头,后跟要恢复到的那个提交的标题。然后在消息正文中,应该写上“This reverts commit ”,其中“”是要还原的那个提交的SHA值。

三.影响范围

范围不是固定值,它可以是你提交代码实际影响到的任何内容。例如 l o c a t i o n 、 location、 locationbrowser、 c o m p i l e 、 compile、 compilerootScope、ngHref、ngClick、ngView等,唯一需要注意的是它必须足够简短。
当修改影响多个范围时,也可以使用“*”。

四.标题

标题是对变更的简明描述:

  • 使用祈使句,现在时态:是“change”不是“changed”也不是“changes”
  • 不要大写首字母
  • 结尾不要使用句号

五.正文

正文是对标题的补充,但它不是必须的。和标题一样,它也要求使用祈使句且现在时态,正文应该包含更详细的信息,如代码修改的动机,与修改前的代码对比等。

六. 页脚

任何Breaking Changes(破坏性变更,不向下兼容)都应该在页脚中进行说明,它经常也用来引用本次提交解决的GitHub Issue。
Breaking Changes应该以“BREAKING CHANGE:”开头,然后紧跟一个空格或两个换行符,其他要求与前面一致。

七、参考链接

https://github.com/angular/angular.js/commits/master
https://github.com/angular/angular.js/blob/master/CHANGELOG.md
https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commitguidelines
https://docs.google.com/documen

相关文章:

  • ❤ HbuildX使用以及快捷键
  • 【深度学习:Synthetic Training Data 】合成训练数据简介
  • 做数据缓存,Map 比List更具有优势
  • 直播预告丨看零售场,如何玩转 MaaS
  • UDP传输总丢包?常用的解决方式在这里!
  • 在Linux系统中创建虚拟串口
  • Go+快速开始详细指南
  • 十三、Three场景物体增加发光特效
  • EVE-NG的环境导入IOL组件
  • 算法竞赛备赛进阶之数位DP训练
  • 跨境电商多账号防关联攻略分享,盘点那些可以多账号登录的指纹浏览器
  • React18-树形菜单-递归
  • electron+vue项目使用serialport报错Cannot read property ‘indexOf‘ of undefined解决办法
  • QT笔记 - 加载带有提升为自定义部件类的“.ui“文件 - 重写QUiLoader::createWidget()函数
  • MySQL进阶篇(六)InnoDB 引擎
  • CSS进阶篇--用CSS开启硬件加速来提高网站性能
  • Date型的使用
  • docker python 配置
  • ES6系统学习----从Apollo Client看解构赋值
  • GitUp, 你不可错过的秀外慧中的git工具
  • Git初体验
  • JavaScript-Array类型
  • Java小白进阶笔记(3)-初级面向对象
  • Linux快速复制或删除大量小文件
  • Logstash 参考指南(目录)
  • node学习系列之简单文件上传
  • Ruby 2.x 源代码分析:扩展 概述
  • SQLServer之创建数据库快照
  • STAR法则
  • VuePress 静态网站生成
  • 大型网站性能监测、分析与优化常见问题QA
  • 排序(1):冒泡排序
  • 前端攻城师
  • 浅谈web中前端模板引擎的使用
  • 世界上最简单的无等待算法(getAndIncrement)
  • 双管齐下,VMware的容器新战略
  • 携程小程序初体验
  • 新手搭建网站的主要流程
  • 白色的风信子
  • 通过调用文摘列表API获取文摘
  • ​ssh-keyscan命令--Linux命令应用大词典729个命令解读
  • #etcd#安装时出错
  • #传输# #传输数据判断#
  • #我与虚拟机的故事#连载20:周志明虚拟机第 3 版:到底值不值得买?
  • (DFS + 剪枝)【洛谷P1731】 [NOI1999] 生日蛋糕
  • (Ruby)Ubuntu12.04安装Rails环境
  • (附源码)springboot人体健康检测微信小程序 毕业设计 012142
  • (接口自动化)Python3操作MySQL数据库
  • (一)Thymeleaf用法——Thymeleaf简介
  • (一)VirtualBox安装增强功能
  • (中等) HDU 4370 0 or 1,建模+Dijkstra。
  • (转)C语言家族扩展收藏 (转)C语言家族扩展
  • (轉貼)《OOD启思录》:61条面向对象设计的经验原则 (OO)
  • (总结)Linux下的暴力密码在线破解工具Hydra详解
  • ... fatal error LINK1120:1个无法解析的外部命令 的解决办法