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)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • linux读写锁

    linux读写锁读写锁与互斥量类似,但读写锁允许更高的并行性。其特性为:写独占,读共享。读写锁状态:一把读写锁具备三种状态:1.读模式下加锁状态(读锁)2.写模式下加锁状态(写锁)3.不加锁状态读写锁特性:1. 读写锁是“写模式加锁”时,解锁前,所有对该锁加锁的线程都会被阻塞。2. 读写锁是“读模式加锁”时,如果线程以读模式对其加锁会成功;如果线程以写模式加

    2022年8月12日
    6
  • Dubbo框架(Javassm框架)

    1.Dubbo是什么?Dubbo是一个分布式服务框架,致力于提供高性能和透明化的RPC远程服务调用方案,以及SOA服务治理方案。简单的说,dubbo就是个服务框架,如果没有分布式的需求,其实是不需要用的,只有在分布式的时候,才有dubbo这样的分布式服务框架的需求,并且本质上是个服务调用的东东,说白了就是个远程服务调用的分布式框架(告别WebService模式中的WSdl,以服务者

    2022年4月11日
    69
  • 据说年薪30万的Android程序员必须知道的帖子「建议收藏」

    据说年薪30万的Android程序员必须知道的帖子「建议收藏」Android中国开发精英目前包括:  Android开源项目第一篇——个性化控件(View)篇    包括ListView、ActionBar、Menu、ViewPager、Gallery、GridView、ImageView、ProgressBar、TextView、ScrollView、TimeView、TipView、FlipView、ColorPickView、GraphV

    2022年6月14日
    115
  • Stream流的常用方法[通俗易懂]

    Stream流的常用方法[通俗易懂]1、快速创建ListListlist=Stream.of(“1″,”2”).collect(Collectors.toList());2、取对象的某一列低效方式:List<String>userNameList=newArrayList<>();for(String)List<String>userNameList=list.stream().map(User::getName).collect(Collectors.toList(

    2022年10月5日
    2
  • 【嵌入式】C语言中volatile关键字

    【嵌入式】C语言中volatile关键字00.目录文章目录00.目录01.volatile概述02.volatile应用场景03.volatile应用示例04.嵌入式系统中应用05.volatile官方说明volatile06.附录01.volatile概述volatile是C语言中的一个关键字。将变量定义为volatile就表示告诉编译器这个变量可能会被竟想不到地改变,在这种情况下,编译器就不会去假设这个变量的值了,及优化器在用到这个变量是必须每次重新读取他的值。02.volatile应用场景在程序中,volati

    2022年7月27日
    9
  • 转 提问的智慧

    转 提问的智慧维基入口: 提问的智慧英文版http://www.catb.org/~esr/faqs/smart-questions.html中文版http://www.beiww.com/doc/oss/smart-questions.html

    2022年7月26日
    6

发表回复

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

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