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


相关推荐

  • 【Android 】零基础到飞升 | ExpandableListView(可折叠列表)的基本使用

    【Android 】零基础到飞升 | ExpandableListView(可折叠列表)的基本使用2.5.5ExpandableListView(可折叠列表)的基本使用本节引言:本节要讲解的Adapter类控件是ExpandableListView,就是可折叠的列表,它是ListView的子类,在ListView的基础上它把应用中的列表项分为几组,每组里又可包含多个列表项。至于样子,类似于QQ联系人列表,他的用法与ListView非常相似,只是ExpandableListVivew显示的列表项需由ExpandableAdapter提供。下面我们来学习这个控件的基本使用!官方API:Exp

    2022年6月15日
    23
  • Kafka入门经典教程_kafka菜鸟教程

    Kafka入门经典教程_kafka菜鸟教程转自:https://blog.csdn.net/yuan_xw/article/details/512109541Kafka入门教程1.1消息队列(MessageQueue)MessageQueue消息传送系统提供传送服务。消息传送依赖于大量支持组件,这些组件负责处理连接服务、消息的路由和传送、持久性、安全性以及日志记录。消息服务器可以使用一个或多个代理实例。J…

    2022年10月16日
    3
  • pytest报错_pycharm git使用

    pytest报错_pycharm git使用前言我们每天写完自动化用例后都会提交到git仓库,随着用例的增多,为了保证仓库代码的干净,当有用例新增的时候,我们希望只运行新增的未提交git仓库的用例。pytest-picked插件可以

    2022年8月6日
    9
  • Hive数据类型[通俗易懂]

    Hive数据类型[通俗易懂]1.Hive数据类型Hive支持原始数据类型和复杂类型,原始类型包括数值型,Boolean,字符串,时间戳。复杂类型包括数组,map,struct。下面是Hive数据类型的一个总结:分类类型描述字面量示例原始类型BOOLEANtrue/falseTRUETINYINT1字节的有符号整数-128~1271YSMALL

    2022年4月19日
    73
  • java语言的平台无关性是指什么,《深入Java虚拟机》学习笔记二:平台无关性

    java语言的平台无关性是指什么,《深入Java虚拟机》学习笔记二:平台无关性第二章平台无关1、Java体系结构对平台无关性的支持对平台无关性的支持,是分布在整个Java体系结构中的,所有的组成部分,包括语言、class文件、API及虚拟机,都在对平台无关性的支持方面扮演着重要角色。Java平台扮演一个运行Java程序与其下的硬件和操作系统间的缓冲角色。Java程序被编译为可运行于Java虚拟机的二进制程序,并且假定JavaAPI的class文件在运行时都是可用的,接着虚…

    2022年7月7日
    24
  • gridView自己定义做时间排版「建议收藏」

    gridView自己定义做时间排版

    2022年1月23日
    38

发表回复

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

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