阮一峰的网络日志 |
Commit message 和 Change log 编写指南 Posted: 06 Jan 2016 05:23 AM PST Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。
上面代码的 如果一行不够,可以只执行
但是,一般来说,commit message 应该清晰明了,说明本次提交的目的。 目前,社区有多种 Commit message 的写法规范。本文介绍Angular 规范(见上图),这是目前使用最广的写法,比较合理和系统化,并且有配套的工具。 一、Commit message 的作用格式化的Commit message,有几个好处。 (1)提供更多的历史信息,方便快速浏览。 比如,下面的命令显示上次发布后的变动,每个commit占据一行。你只看行首,就知道某次 commit 的目的。
(2)可以过滤某些commit(比如文档改动),便于快速查找信息。 比如,下面的命令仅仅显示本次发布新增加的功能。
(3)可以直接从commit生成Change log。 Change Log 是发布新版本时,用来说明与上一个版本差异的文档,详见后文。 二、Commit message 的格式每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。
其中,Header 是必需的,Body 和 Footer 可以省略。 不管是哪一个部分,任何一行都不得超过72个字符(或100个字符)。这是为了避免自动换行影响美观。 2.1 HeaderHeader部分只有一行,包括三个字段: (1)type
如果 (2)scope
(3)subject
2.2 BodyBody 部分是对本次 commit 的详细描述,可以分成多行。下面是一个范例。
有两个注意点。 (1)使用第一人称现在时,比如使用 (2)应该说明代码变动的动机,以及与以前行为的对比。 2.3 FooterFooter 部分只用于两种情况。 (1)不兼容变动 如果当前代码与上一个版本不兼容,则 Footer 部分以
(2)关闭 Issue 如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。
也可以一次关闭多个 issue 。
2.4 Revert还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以
Body部分的格式是固定的,必须写成 如果当前 commit 与被撤销的 commit,在同一个发布(release)里面,那么它们都不会出现在 Change log 里面。如果两者在不同的发布,那么当前 commit,会出现在 Change log 的 三、CommitizenCommitizen是一个撰写合格 Commit message 的工具。 安装命令如下。
然后,在项目目录里,运行下面的命令,使其支持 Angular 的 Commit message 格式。
以后,凡是用到 四、validate-commit-msgvalidate-commit-msg 用于检查 Node 项目的 Commit message 是否符合格式。 它的安装是手动的。首先,拷贝下面这个JS文件,放入你的代码库。文件名可以取为 接着,把这个脚本加入 Git 的 hook。下面是在
然后,每次
五、生成 Change log如果你的所有 Commit 都符合 Angular 格式,那么发布新版本时, Change log 就可以用脚本自动生成(例1,例2,例3)。 生成的文档包括以下三个部分。
每个部分都会罗列相关的 commit ,并且有指向这些 commit 的链接。当然,生成的文档允许手动修改,所以发布前,你还可以添加其他内容。 conventional-changelog 就是生成 Change log 的工具,运行下面的命令即可。
上面命令不会覆盖以前的 Change log,只会在 如果你想生成所有发布的 Change log,要改为运行下面的命令。
为了方便使用,可以将其写入
以后,直接运行下面的命令即可。
(完) |
You are subscribed to email updates from 阮一峰的网络日志. To stop receiving these emails, you may unsubscribe now. | Email delivery powered by Google |
Google Inc., 1600 Amphitheatre Parkway, Mountain View, CA 94043, United States |