git commit 提交规范
一直都不规范,希望以后开始可以规范点
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
(1)type
提交 commit 的类型,包括以下几种
feat: 新功能
fix: 修复问题
docs: 修改文档
style: 修改代码格式,不影响代码逻辑
refactor: 重构代码,理论上不影响现有功能
perf: 提升性能
test: 增加修改测试用例
chore: 修改工具相关(包括但不限于文档、代码生成等)
deps: 升级依赖
(2)scope
- 修改文件的范围(包括但不限于 doc, middleware, proxy, core, config)
(3)subject
- 用一句话清楚的描述这次提交做了什么
(4)body
- 补充 subject,适当增加原因、目的等相关因素,也可不写。
(5)footer
- 当有非兼容修改时可在这里描述清楚
- 关联相关 issue,如
Closes #1, Closes #2, #3
- 如果功能点有新增或修改的,还需要关联
chair-handbook
和chair-init
的 MR,如chair/doc!123
示例
1. 简单示例
fix: xxx components render twice problem fixed. git commit -m "fix: xxx components render twice problem fixed."
2. 复杂示例
fix($compile): couple of unit tests for IE9 Older IEs serialize html uppercased, but IE9 does not... Would be better to expect case insensitive, unfortunately jasmine does not allow to user regexps for throw expectations. Document change on chair/doc!123 Closes #392 Breaks foo.bar api, foo.baz should be used instead