【GIT】Commit message 和 Change log 编写指南
转自: http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html 作者: 阮一峰 Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。 $ git commit -m "hello world" 上面代码的 -m 参数,就是用来指定 commit mesage 的。 如果一行不够,可以只执行 git commit ,就会跳出文本编辑器,让你写多行。 $ git commit 基本上,你写什么都行( 这里 , 这里 和 这里 )。 但是,一般来说,commit message 应该清晰明了,说明本次提交的目的。 目前,社区有多种 Commit message 的 写法规范 。本文介绍 Angular 规范 (见上图),这是目前使用最广的写法,比较合理和系统化,并且有配套的工具。 一、Commit message 的作用 格式化的Commit message,有几个好处。 (1)提供更多的历史信息,方便快速浏览。 比如,下面的命令显示上次发布后的变动,每个commit占据一行。你只看行首,就知道某次 commit 的目的。 $ git log <last tag> HEAD --pretty=format:%s (2)可以过滤某些commit(比如文档改动)