目的
- 统一团队 Git commit 日志标准,便于后续代码 review,版本发布以及日志自动化生成等等。
- 统一团队的 Git 工作流,包括分支使用、tag 规范、issue 等。
总体方案
doc || docs :仅仅修改了文档,例如readme文件这些。
Type(中文) | Type类型(英文) | 描述 |
---|---|---|
功能 | feat | 新增feature |
修复 | fix | 修复 bug |
文档 | docs | 仅仅修改了文档,比如 README, CHANGELOG, CONTRIBUTE等等 |
格式 | style | 仅仅修改了空格、格式缩进、逗号等等,不改变代码逻辑 |
重构 | refactor | 代码重构,没有加新功能或者修复 bug |
优化 | pref | 优化相关,比如提升性能、体验 |
测试 | test | 测试用例,包括单元测试、集成测试等 |
回滚 | chore | 改变构建流程、或者增加依赖库、工具等 |
更新 | revert | 回滚到上一个版本 |
示例:
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。