大家好,又见面了,我是你们的朋友全栈君。
俗话说,无规矩不成方圆。
前端时间,阿里诚意献上重磅大礼:《阿里巴巴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 部分
日志的内容页脚 footer 用来描述一些补充信息,可写可不写。
例如修复了 GitHub 平台上某个 issue 或多个 issue:
Closes #120
Closes #123, #245, #992
参考资料
AngularJS 代码贡献指南
Karma 的 Git 日志规约
发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/134091.html原文链接:https://javaforall.cn
【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛
【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...