近一年来,我一直在用一种更有条理的方式来写git提交。它改善了代码审查和对代码历史的浏览。受angular提交信息的启发,我采用了他们的提交信息准则。下面是一些例子
fix(release): need to depend on latest rxjs and zone.js docs(changelog): update change log to beta.5
瞬间,你会注意到基于这些提交标题的大图片和小图片。有了这个,你可以立即解析出一个类型和范围,这就立即为你准备了一个代码的上下文,而不是为了了解发生了什么而略过文件和代码变化。在你的工作流程中尝试一下,让我知道它对你和你的团队有什么作用下面是一些核心类型的摘录。
- **壮举。**一个新功能
- **修复。**一个错误修复
- **docs:**只修改文档
- **风格。**不影响代码含义的修改(白字、格式化、缺少分号等)。
- **重构。**既不修复错误也不增加功能的代码修改
- **perf:**一种提高性能的代码修改
- **测试。**增加缺失的测试或纠正现有的测试
- **构建。**影响构建系统或外部依赖的变化(例如范围:gulp、broccoli、npm)。
- **ci:**对我们的CI配置文件和脚本的改变(例子范围:Travis、Circle、BrowserStack、SauceLabs)
- **chore。**其他不修改 src 或测试文件的改动
提交信息的格式
每条提交信息都由一个页眉、一个正文和一个页脚组成。头部有一个特殊的格式,包括一个类型、一个范围和一个主题。
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
提交信息的任何一行都不能超过100个字符!这使得信息在GitHub以及各种git工具中更容易阅读。