本文档描述了代码提交日志的规范
目标
- 提高repo的可维护性
- 更好的记录提交历史
- 支持CHANGELOG.md自动生成
格式
<类型>(范围): <主题>
<空行>
<正文>
<空行>
类型
type必填,表示该commit的性质,有以下几种type:
- feat:一个新feature
- fix:一个bugfix
- docs:仅文档修改
- style:不影响代码含义的修改,如空格/代码格式/标点符号等
- refactor:既不是新feature也不是bugfix的重构内容
- perf:提升性能的内容
- test:测试代码的改动
- chore:对构建流程/辅助工具或库(例如文档生成)的改动
范围
scope为可选内容,用来说明commit改变涉及的范围,可以是某个模块/功能,或某个具体的issue,如fix(cli),feat(api),fix(BBS-101)
主题