提交信息规范
组织好的提交信息, 可以提高项目的整体质量. 至少具有下面这些优点:
- 格式统一的提交信息有助于自动化生成CHANGELOG
- 版本库不只是存放代码的仓库, 它记录项目的开发日志, 它应该要清晰表达这次提交的做了什么. 这些记录应该可以帮助后来者快速地学习和回顾代码, 也应该方便其他协作者review你的代码
- 规范化提交信息可以促进提交者提交有意义的、粒度合适的’提交’. 提交者要想好要怎么描述这个提交,这样被动促进了他们去把控提交的粒度
社区上比较流行的提交信息规范是Angular的提交信息规范, 除此之外,这些也很不错:
另外这些工具可以帮助你检验提交信息, 以及生成CHANGELOG:
- conventional-changelog - 从项目的提交信息中生成CHANGELOG和发布信息
- commitlint - 检验提交信息
- commitizen - 🔥简单的提交规范和提交帮助工具,推荐
- standard-changelog - angular风格的提交命令行工具