Git规范:Git提交规范

Git规范:Git提交规范1 Commitmessag 格式 type scope subject 1 type 必须 作用 用于说明 Gitcommit 的类别 只允许使用下面的标识 feat 新功能 feature fix to 修复 bug 可以是 QA QualityAssur 发现的 BUG 也可以是研发自己发现的 BUG 备注 fix 产生 diff 并自动修复此问题 适合于一次提交直接修复问题 to 只产生 diff 不自动修复此问题 subject scope type

目录

一、为什么要制定提交规范?

二、如何制定提交规范?

三、具体案例


一、为什么要制定提交规范?

  1. 便于程序员对提交历史进行追溯,了解发生了什么情况。
  2. 一旦约束了 Commit Message ,意味着我们将慎重的进行每一次提交,不能再一股脑的把各种各样的改动都放在一个git commit里面,这样一来整个代码改动的历史也将更加清晰。
  3. 格式化的 Commit Message 才可以用于自动化输出 Change log 。

二、如何制定提交规范?

业界通用的Git提交规范:

<type>(<scope>):<subject>
  • type
    • 作用
      • 用于说明 Git Commit 的类别,只允许使用下面的标识。
    • 标识
      • sync:同步主线或分支的bug。
      • merge:代码合并。
      • revert:回滚到上一个版本。
      • chore:构建过程或辅助工具的变动。
      • test:增加测试。
      • perf:优化相关,比如提升性能、体验。
      • refactor:重构(既不是新增功能,也不是修改bug的代码变动)。
      • style:格式(不影响代码运行的变动)。
      • docs:文档(documentation)。
      • fix / to:修复bug,可以是QA(Quality Assurance)发现的bug,也可以是研发自己发现的bug。
      • feat:新功能(feature)。
  • scope
    • 作用
      • scope用于说明 Commit 影响的范围,比如数据层、控制层、视图层等,视项目不同而不同。
    • 例子
      • 在JAVA,可以是Controller,Service,Dao等。
      • 在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。
      • 如果你的修改影响了不止一个scope,你可以使用*代替。
  • subject
    • 作用
      • subject是 Commit 目的的简短描述,一般不超过50个字符。
    • 注意事项
      • 建议使用中文。
      • 结尾不加句号或其他标点符号。

三、具体案例

feat(Controller):用户查询接口开发 fix(Dao):用户查询缺少username属性

以上就是Git的提交规范和具体案例,如果本篇文章对你有帮助,请一键三连支持,谢谢。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/232045.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • tracert 原理_公道杯原理图解

    tracert 原理_公道杯原理图解Tracert原理

    2022年9月25日
    4
  • intellij idea全局查找和替换[通俗易懂]

    intellij idea全局查找和替换[通俗易懂]点击这里查看&lt;intellijidea使用教程汇总篇&gt;全局查找通过快捷键Ctrl+Shift+f快速进入全局查找页面,或者通过Edit》Find》FindInPath 1、你要检索的内容;2、如何匹配内容,分别表示区分大小写、单个单词、正则、过滤查找文件;3、查找范围,分别表示在整个项目中查找、在指定模块中查找、在指定目录下查找、在指定…

    2022年6月15日
    118
  • 数据库三范式

    数据库三范式

    2021年5月11日
    146
  • mos双向电平转换电路_二极管电平转换电路

    mos双向电平转换电路_二极管电平转换电路电平转换电路在电路设计中会经常用到,市面上也有专用的电平转换芯片,专用的电平转换芯片主要是其转换速度较快,多使用在速度较高的通讯接口,一般对速度要求不高的控制电路,则可使用此文介绍的分立器件搭建的电平转换电路。1、NPN三极管下图使用NPN三极管搭建的电平转化电路属于单向的电平转换信号发生器:3.3V,10k,50%,方波注意事项:(1)该电路的信…

    2022年8月10日
    5
  • Unity 3D 入门基础[通俗易懂]

    Unity 3D 入门基础[通俗易懂]1.1菜单栏File(文件):打开和保存场景、项目、以及创建游戏。Edit(编辑):主要用于Unity内部功能、快捷键设置。Assets(资源):用于资源的创建、导入和导出。GameObject(游戏对象):用于游戏对象的创建。Component:(游戏组件):为游戏对象等添加组件来实现部分功能。Window(窗口):显示特定视图。Help(帮助):主要包含使用手册、资源商店、论坛等。1.2五个视图层级视图(Hierarchy):主要存放游戏场景中的具体的游戏对象。场

    2022年8月10日
    18
  • java到大数据学习路线

    java到大数据学习路线计算机网络 操作系统 数据结构 计算机组成原理 可重点学习如下知识点计算机网络(重点看OSI七层模型或TCP/IP五层模型理解每层含义)数据结构(重点看数组、栈、队列、链表、树)算法(重点看各种排序算法、查找算法、去重算法,最优解算法,多去LeetCode刷算法题)操作系统(重点看进程、线程、IO、调度、内存管理) 数据仓库分为离线数仓和实时数仓,但是企业在招聘时大多要求两者都会,进入公司之后可能会专注于离线或实时其中之一。不…

    2022年5月8日
    44

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号