git commit 规范指南
haplake
8年前
<h2>前言</h2> <p>Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。</p> <p>不过话说回来，作为最具个人创造力和最会利用工具的物种——程序猿，最好是能有规范和工具的约束。否者的话，你可能看到以下的 commit message ：</p> <p style="text-align: center;"><img src="https://simg.open-open.com/show/c3d768e4237cc60f0a1ca32e97836025.png"></p> <p>目前，社区有多种 Commit message 的写法规范。本文介绍 Angular 规范 是目前使用最广的写法，比较合理和系统化，并且有配套的工具。前前端框架 Angular.js 采用的就是该规范。如下图：</p> <p style="text-align: center;"><img src="https://simg.open-open.com/show/668bd1a2eb345dc2bb176a87a952b658.png"></p> <h2>Commit message 的作用</h2> <h3>提供更多的历史信息，方便快速浏览。</h3> <p>比如，下面的命令显示上次发布后的变动，每个commit占据一行。你只看行首，就知道某次 commit 的目的。</p> <pre> $ git log <last tag> HEAD --pretty=format:%s</pre> <p style="text-align: center;"><img src="https://simg.open-open.com/show/0df0aa4746ccac73f1a9dcc5b4398b15.png"></p> <h3>可以过滤某些commit（比如文档改动），便于快速查找信息</h3> <pre> $ git log <last release> HEAD --grep feature</pre> <h3>可以直接从commit生成Change log。</h3> <p>Change Log 是发布新版本时，用来说明与上一个版本差异的文档，详见后文。</p> <p><img src="https://simg.open-open.com/show/5cdc2d5e57877213f8e05bad8d2cb5d4.png"></p> <h3>其他优点</h3> <ul> <li> <p>可读性好，清晰，不必深入看代码即可了解当前commit的作用。</p> </li> <li> <p>为 Code Reviewing做准备</p> </li> <li> <p>方便跟踪工程历史</p> </li> <li> <p>让其他的开发者在运行 git blame 的时候想跪谢</p> </li> <li> <p>提高项目的整体质量，提高个人工程素质</p> </li> </ul> <h2>Commit message 的格式</h2> <p>每次提交，Commit message 都包括三个部分：header，body 和 footer。</p> <pre> <type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer></pre> <p>其中，header 是必需的，body 和 footer 可以省略。</p> <p>不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。</p> <h3>Header</h3> <p>Header部分只有一行，包括三个字段： type （必需）、 scope （可选）和 subject （必需）。</p> <p>type</p> <p>用于说明 commit 的类别，只允许使用下面7个标识。</p> <ul> <li> <p>feat：新功能（feature）</p> </li> <li> <p>fix：修补bug</p> </li> <li> <p>docs：文档（documentation）</p> </li> <li> <p>style： 格式（不影响代码运行的变动）</p> </li> <li> <p>refactor：重构（即不是新增功能，也不是修改bug的代码变动）</p> </li> <li> <p>test：增加测试</p> </li> <li> <p>chore：构建过程或辅助工具的变动</p> </li> </ul> <p>如果type为 feat 和 fix ，则该 commit 将肯定出现在 Change log 之中。其他情况（ docs 、 chore 、 style 、 refactor 、 test ）由你决定，要不要放入 Change log，建议是不要。</p> <p>scope</p> <p>scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。</p> <p>例如在 Angular ，可以是 $location , $browser , $compile , $rootScope , ngHref , ngClick , ngView 等。</p> <p>如果你的修改影响了不止一个 scope ，你可以使用 * 代替。</p> <p>subject</p> <p>subject 是 commit 目的的简短描述，不超过50个字符。</p> <p>其他注意事项：</p> <ul> <li> <p>以动词开头，使用第一人称现在时，比如change，而不是changed或changes</p> </li> <li> <p>第一个字母小写</p> </li> <li> <p>结尾不加句号（.）</p> </li> </ul> <h3>Body</h3> <p>Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。</p> <pre> More detailed explanatory text, if necessary. Wrap it to about 72 characters or so. Further paragraphs come after blank lines. - Bullet points are okay, too - Use a hanging indent</pre> <p>有两个注意点:</p> <ul> <li> <p>使用第一人称现在时，比如使用change而不是changed或changes。</p> </li> <li> <p>永远别忘了第2行是空行</p> </li> <li> <p>应该说明代码变动的动机，以及与以前行为的对比。</p> </li> </ul> <h3>Footer</h3> <p>Footer 部分只用于以下两种情况：</p> <p>不兼容变动</p> <p>如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。</p> <pre> BREAKING CHANGE: isolate scope bindings definition has changed. To migrate the code follow the example below: Before: scope: { myAttr: 'attribute', } After: scope: { myAttr: '@', } The removed `inject` wasn't generaly useful for directives so there should be no code using it.</pre> <p>关闭 Issue</p> <p>如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。</p> <pre> Closes #234</pre> <h3>Revert</h3> <p>还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。</p> <pre> revert: feat(pencil): add 'graphiteWidth' option This reverts commit 667ecc1654a317a13331b17617d973392f415f02.</pre> <p>Body部分的格式是固定的，必须写成 This reverts commit <hash> .，其中的hash是被撤销 commit 的 SHA 标识符。</p> <p>如果当前 commit 与被撤销的 commit，在同一个发布（release）里面，那么它们都不会出现在 Change log 里面。如果两者在不同的发布，那么当前 commit，会出现在 Change log 的Reverts小标题下面。</p> <h2>Commitizen</h2> <p>可以使用典型的git工作流程或通过使用CLI向导 Commitizen 来添加提交消息格式。</p> <h3>安装</h3> <pre> npm install -g commitizen</pre> <p>然后，在项目目录里，运行下面的命令，使其支持 Angular 的 Commit message 格式。</p> <pre> commitizen init cz-conventional-changelog --save --save-exact</pre> <p>以后，凡是用到 git commit 命令，一律改为使用 git cz 。这时，就会出现选项，用来生成符合格式的 Commit message。</p> <p style="text-align: center;"><img src="https://simg.open-open.com/show/bd067dba7814b556cbffcaa2de118069.png"></p> <h2>validate-commit-msg</h2> <p>validate-commit-msg 用于检查 Node 项目的 Commit message 是否符合格式。</p> <p>它的安装是手动的。首先，拷贝下面这个 JS文件 ，放入你的代码库。文件名可以取为 validate-commit-msg.js 。</p> <p>接着，把这个脚本加入 Git 的 hook。下面是在 package.json 里面使用 ghooks，把这个脚本加为 commit-msg 时运行。</p> <p>然后，每次git commit的时候，这个脚本就会自动检查 Commit message 是否合格。如果不合格，就会报错。</p> <pre> $ git add -A $ git commit -m "edit markdown" INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" ! was: edit markdown</pre> <h2>生成 Change log</h2> <p>如果你的所有 Commit 都符合 Angular 格式，那么发布新版本时， Change log 就可以用脚本自动生成。生成的文档包括以下三个部分：</p> <ul> <li> <p>New features</p> </li> <li> <p>Bug fixes</p> </li> <li> <p>Breaking changes.</p> </li> </ul> <p>每个部分都会罗列相关的 commit ，并且有指向这些 commit 的链接。当然，生成的文档允许手动修改，所以发布前，你还可以添加其他内容。</p> <p>conventional-changelog 就是生成 Change log 的工具，运行下面的命令即可。</p> <pre> $ npm install -g conventional-changelog $ cd my-project $ conventional-changelog -p angular -i CHANGELOG.md -w</pre> <p> </p> <p>来自：https://segmentfault.com/a/1190000009048911</p> <p> </p>