［译］AngularJSGit提交信息规范

目标
- 生成 CHANGELOG.md
- 识别不重要的提交
- 在浏览 Git 历史时提供更多信息
格式化提交信息
- 恢复(Revert)
- 信息头部
  
  - 必需- 必需- 文本
- 信息主体
- 信息尾部
  
  - 重大更改(Breaking changes)- 引用讨论(Referencing issues)

目标

能够通过脚本生成 CHANGELOG.md
能让 git bisect 过程忽略不重要的提交
在浏览历史时提供更好的信息

生成 CHANGELOG.md

我们在 changeling 里使用这三个标志: new features, bug fixes, breaking changes.
在做一个发行版的时候&＃xff0c;这个列表可以通过脚本来生成&＃xff0c;通过关联这些相关的提交。
自然&＃xff0c;你可以在实际发行之前编辑这些变更日志&＃xff0c;但是这样子可以很容易的生成骨架。

列出自最近一次发行以来所有的主体&＃xff08;提交信息第一行&＃xff09;

>> git log HEAD —pretty&＃61;format:%s

在本次发行内的新功能

>> git log HEAD —grep feature

识别不重要的提交

通常有很多的Formatting changes(adding/removing spaces/empty lines, indentation), missing semicolons, comments.所以当你查找一些变更的时候&＃xff0c;你可以忽略这些提交 - 这些提交里面没有业务逻辑变更。

当二分查找的时候&＃xff0c;你可以忽视这些提交通过键入以下命令&＃xff1a;

>> git bisect skip $(git rev-list —grep irrelevant HEAD)

在浏览历史时提供更多信息

这将会增加一种“context”信息
看这些信息&＃xff08;通过查看最近的 angularjs 的提交信息&＃xff09;

Fix small typo in docs widget (tutorial instructions)
Fix test for scenario.Application - should remove old iframe
docs - various doc fixes
docs - stripping extra new lines
Replaced double line break with single when text is fetched from Google
Added support for properties in documentation

所有这些信息都尝试去表明更改的位置&＃xff0c;但是它们没有使用公共的规范
再看看这些信息&＃xff1a;

fix comment stripping
fixing broken links
Bit of refactoring
Check whether links do exist and throw exception
Fix sitemap include (to work on case sensitive linux)

你能猜出这里面到底装了些什么&＃xff1f;这些信息缺乏重点。
也许还有这些代码&＃xff1a;docs, docs-parser, compiler, scenario-runner, ...
我知道&＃xff0c;你可以通过查看哪些文件被改变来确定这个提交到底做了什么&＃xff0c;但是这样子太麻烦了。
当查看 git 历史信息的时候我们可以看到大家都在努力保持一致&＃xff0c;但是缺少一个公共规范。