Git提交规范

一. 修改类型

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

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

二.代码回滚

代码回滚比较特殊,如果本次提交是为了恢复到之前的某个提交,那提交消息应该以

"revert:"开头,后跟要恢复到的那个提交的标题。然后在消息正文中,应该写上"This reverts commit ",其中""是要还原的那个提交的SHA值。

三.影响范围

范围不是固定值,它可以是你提交代码实际影响到的任何内容。例如location、 b r o w s e r 、 browser、 browser、compile、rootScope、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

相关推荐
程序猿chen20 分钟前
JVM考古现场(十九):量子封神·用鸿蒙编译器重铸天道法则
java·jvm·git·后端·程序人生·java-ee·restful
混血哲谈27 分钟前
如何安装git?
git
尸僵打怪兽5 小时前
gitee基本使用
git·gitee·git使用
冰凌糕7 小时前
Git 远程仓库
git·版本控制
Ring__Rain7 小时前
visual studio 常用的快捷键(已经熟悉的就不记录了)
c++·git·visual studio
烂漫心空7 小时前
Git 基本使用
git
王鑫的博客8869 小时前
git reset详解
git
HinsCoder20 小时前
使用SSH解决在IDEA中Push出现403的问题
运维·笔记·git·ssh·github·intellij-idea
键盘不能没有CV键1 天前
【日志链路】⭐️SpringBoot 整合 TraceId 日志链路追踪!
java·git·intellij-idea
江城开朗的豌豆1 天前
手把手教你定制Vue3项目的Git提交规范:cz-customizable实战
前端·git·程序员