如何写好 Commit Log?
码农天地 -其实关于这个问题,老早都想整理了,只是一直没有腾出空来,最近刚好有空,索性整理了下。
这里就不过多介绍什么是Git
了,本文的重点是Commit Log
,如果还不清楚Git
是什么,可以看一下我的Git
系列的其他笔记。
Reviewing Code
的过程提醒自己或他人,某个提交具体增加了什么功能,改动了哪些地方提高项目的整体质量Angular 规范的 Commit message 格式这种格式(规范)是我目前觉得相对其他格式(规范)而言,最容易接受、上手的一种。
其核心是每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
其中,Header 是必需的,Body 和 Footer 可以省略。
HeaderHeader 部分只有一行,包括三个字段:type(必需)、scope(可选)和 subject(必需)。
type 用于说明 commit
的类别,只允许使用下面几个标识:
scope 用于说明 commit
影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
subject 是 commit
目的的简短描述,不超过 50 个字符。
Body 部分是对本次 commit 的详细描述,可以分成多行。
FooterFooter 部分只用于不兼容变动和关闭 Issue。
总结本来我自己一直使用的方式就是:git commit -am "fix login bug"
,虽然并没有绝对的对错,但这显然不是最好的方式。
这种东西并没有强制性的规定,只要团队之间约定好,然后按照这个约定协作就好了。
所以我觉得在团队之间commit
时,可以不用完全按照Angular 规范的Commit message
格式去提交,可以按照以下约定来执行。
commit
时,只用保留 Header 部分就好。pull request
时,才需要 Header、Body、Footer 这三部分。另外commit
时需要注意以下几点:
commit
,一句话说清楚。一个小改动对应一次commit
,不建议一大堆改动,一次commit
。如果添加的代码会使项目发生极大的变化,那么需要及时更新remade
文件以向他人说明此次更改。最佳实践docs: add FAQ in readme file
feat: increase user login function
fix: fix user login bug
特别申明:本文内容来源网络,版权归原作者所有,如有侵权请立即与我们联系(cy198701067573@163.com),我们将及时处理。
上一篇: 源码解析:Git的第一个提交是什么样的?
下一篇: git