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


相关推荐

  • linux重启nginx命令「建议收藏」

    linux重启nginx命令「建议收藏」先找到nginx进程号,命令如下ps-ef|grepnginx重启命令kill-HUP进程号kill-HUP2072常用命令#杀死进程kill-QUIT2072#强制停止pkill-9nginx#验证nginx配置文件是否正确#方法一:进入nginx安装目录sbin下,输入命令./nginx-t#看到如下显示nginx.confsyntaxisoknginx.conftestissuccessful…

    2022年6月19日
    37
  • Java数组删除指定元素

    Java数组删除指定元素//删除数组中其中一个元素publicstaticvoidtestB(){String[]str={“Java”,”C++”,”Php”,”C#”,”Python”};//删除phpList<String>list=newArrayList<String>();for(inti=0;i<str.length;i++){list.add(str[i]

    2022年8月11日
    3
  • Idea激活码永久有效Idea2020.1.1激活码教程-持续更新,一步到位「建议收藏」

    Idea激活码永久有效Idea2020.1.1激活码教程-持续更新,一步到位「建议收藏」Idea激活码永久有效2020.1.1激活码教程-Windows版永久激活-持续更新,Idea激活码2020.1.1成功激活

    2022年6月17日
    25
  • QMap与QHash

    QMap与QHash转载:http://newfaction.net/2010/11/17/qt-qhash-and-qmap-difference.html关联容器可以保存任意多个具有相同类型的项,且它们由一个键索引。Qt提供两个主要的关联容器类:QMap&lt;K,T&gt;和QHash&lt;K,T&gt;。     QMap&lt;K,T&gt;是一个以升序键顺序存储键值对的数据结构…

    2022年5月29日
    31
  • MySQL 如何实现递归查询?「建议收藏」

    MySQL 如何实现递归查询?「建议收藏」点击上方IT牧场,选择置顶或者星标技术干货每日送达!前言最近在做的业务场景涉及到了数据库的递归查询。我们公司用的Oracle,众所周知,Oracle自带有递归查询的功能,所以…

    2022年6月16日
    211
  • php源码审计_静态代码审计

    php源码审计_静态代码审计最近在学PHP代码审计,那就将学习的笔记都整理一遍吧~前期准备:1、安装相关软件,如Sublimetext、 Notepad++、editplus、 Seay源代码审计系统等2、获得源码,可以到网上下载各种网站源码3、安装网站审计方法:通读全文法:麻烦但全面敏感函数参数回溯法:高效常用,Seay源代码审计系统定向功能分析法:主要根据程序的业

    2022年10月2日
    0

发表回复

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

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