根据 angular 规范提交 commit, 这样 history 看起来更加清晰,还可以自动生成 changelog。
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
type
提交 commit 的类型,包括以下几种
- feat: 新功能
- fix: 修复问题
- docs: 修改文档
- style: 修改代码格式,不影响代码逻辑
- refactor: 重构代码,理论上不影响现有功能
- perf: 提升性能
- test: 增加修改测试用例
- chore: 修改工具相关(包括但不限于文档、代码生成等)
- deps: 升级依赖
scope
修改文件的范围(包括但不限于 doc, middleware, core, config, plugin)
subject
用一句话清楚的描述这次提交做了什么
body
补充 subject,适当增加原因、目的等相关因素,也可不写。
footer
当有非兼容修改(Breaking Change)时必须在这里描述清楚
关联相关 issue,如 Closes #1, Closes #2, #3
如果功能点有新增或修改的,还需要关联文档 doc 和 egg-init 的 PR,如 eggjs/egg-bin#123