Git提交日志格式规约[通俗易懂]

Git提交日志格式规约[通俗易懂]俗话说,无规矩不成方圆。前端时间,阿里诚意献上重磅大礼:《阿里巴巴Java开发手册》,首次公开阿里官方Java代码规范标准。这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大降低代码维护成本。那么问题来了,Git提交日志是否需要规范化呢?答案是肯定的。

大家好,又见面了,我是你们的朋友全栈君。

俗话说,无规矩不成方圆。

前端时间,阿里诚意献上重磅大礼:《阿里巴巴Java开发手册》,首次公开阿里官方Java代码规范标准。这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大降低代码维护成本。

那么问题来了,Git提交日志是否需要规范化呢?答案是肯定的。

此时,请允许我班门弄斧附图一张
这里写图片描述
一目了然,整齐划一,有木有?同时也更能快速定位节点做过什么操作。

提交日志基本格式

<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>

其中需要注意的是,首行部分是必需的,而 body 和 footer 部分可选。
<subject>, <body>, <footer>内容默认使用中文。

header部分

第一行不能超过70个字符,第二行总是空白,其他行应该包含80个字符。类型和范围应该总是小写,如下所示。

type 取值

  • feat(用户的新功能,而不是构建脚本的新功能)
  • fix(对用户的错误修复,而不是构建脚本的修复)
  • docs(对文档的更改)
  • style(代码格式化改动,缺少分号等)
  • refactor(重构代码,例如重命名变量)
  • test(新增或修改测试用例)
  • chore(更新咕噜任务等;没有生产代码的变化)

scope

这个取值可以是空,通常用于指明修改内容的范围。

subject

用于概括一次提交行为囊括的内容

  • 时态方面使用一般现在时,不要用过去时态。虽然查看 log 时,log 内容本身都发生在过去,然而对于主题来说,使用现在时的时态更简洁明确,并且更易达成一致性。
  • 句式使用祈使句式。即一般情况不要增加主语。因为在绝大情况下,主语都是作者「我」。
  • 句尾无需结束标点;如果使用英语,则句首同样无需大写。同样是因为主题(或称标题)本身不用形成完整的句子。

body部分

日志的内容主体 body 用来描述详细的提交内容,可写可不写。

日志的内容页脚 footer 用来描述一些补充信息,可写可不写。

例如修复了 GitHub 平台上某个 issue 或多个 issue:

Closes #120

Closes #123, #245, #992

参考资料

AngularJS 代码贡献指南
Karma 的 Git 日志规约

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

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

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


相关推荐

  • 简述php的垃圾收集机制

    简述php的垃圾收集机制

    2022年2月19日
    57
  • math.pow()函数用法[通俗易懂]

    Math.pow(底数,几次方)如:inta=3;intb=3;intc=Math.pow(a,b);就是3的三次方是多少;c最终为27;基础用法:用math.pow()实现数组的交错求和intant=0;a+=b[i]*math.pow(-1,ant);//实…

    2022年4月17日
    357
  • Java 数组在内存中的存储 数组的常见操作

    Java 数组在内存中的存储 数组的常见操作Java 数组在内存中的存储数组的常见操作

    2025年6月29日
    2
  • 多线程(一):创建线程和线程的常用方法

    多线程(一):创建线程和线程的常用方法一:为什么要学多线程应付面试:多线程几乎是面试中必问的题,所以掌握一定的基础知识是必须的。了解并发编程:实际工作中很少写多线程的代码,这部分代码一般都被人封装起来了,在业务中使用多线程的机会也不是很多(看具体项目),但是作为一个高级程序员如果不会多线程是说不过去的。二:进程与线程进程进程是资源(CPU、内存等)分配的基本单位,它是程序执行时的一个实例。程序运行时系统…

    2022年4月28日
    47
  • 孙鑫XML视频教程中关于DOM例子的一点错误

    孙鑫XML视频教程中关于DOM例子的一点错误源代码如下: import java.io.File;import java.io.IOException;import javax.xml.parsers.DocumentBuilder;import javax.xml.parsers.DocumentBuilderFactory;import javax.xml.parsers.ParserConfigurationExcepti

    2022年5月13日
    30
  • Apache配置虚拟主机,关于403问题的解决

    Apache配置虚拟主机,关于403问题的解决安装wamp集成开发环境后,配置虚拟主机,在浏览器中输入虚拟主机的域名,出现403forbidden的错误.在以前的开发工作中就遇到过这种情况,之前一直困扰着我,通过网上搜索,终于解决了这个问题。出现这个问题的原因是目录访问权限没有设置。       具体解决步骤如下:1 打开apache配置文件httpd.conf,找到目录权限的语句   O

    2022年9月17日
    2

发表回复

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

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