Git Commit 提交规范
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Git Commit 提交规范相关的知识，希望对你有一定的参考价值。
写好 Commit message 好处多多：
- 1、统一团队Git commit 日志风格
- 2、方便日后 Reviewing Code
- 3、帮助我们写好 Changelog
- 4、能很好的提升项目整体质量
业界比较推崇 Angular 的 commit 规范 http://suo.im/4rsYee
Commit message 包括三个部分：Header，Body 和 Footer。完整格式如下：
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
1) type
提交 commit 的类型，包括以下几种
- feat: 新功能
- fix: 修复问题
- docs: 修改文档
- style: 修改代码格式，不影响代码逻辑
- refactor: 重构代码，理论上不影响现有功能
- perf: 提升性能
- test: 增加修改测试用例
- chore: 修改工具相关（包括但不限于文档、代码生成等）
2) scope
修改文件的范围，比如：视图层、控制层、docs、config, plugin
3) subject
- subject 是 commit 目的的简短描述（用一句话清楚的描述这次提交做了什么），不超过50个字符
4) body
- 补充 subject 添加详细说明，可以分成多行，适当增加原因、目的等相关因素，也可不写
5 ) footer
- 当有非兼容修改(Breaking Change)时必须在这里描述清楚
- 关闭issue或是链接到相关文档，如 Closes #1, Closes #2, #3
以上是关于Git Commit 提交规范的主要内容，如果未能解决你的问题，请参考以下文章