日志规范
# 提交日志规范
# 日志类型
类型 | 描述 |
---|---|
feat | 新功能 |
fix | 修复bug |
docs | 仅仅修改了文档,比如 README , CHANGELOG , CONTRIBUTE 等 |
style | 格式化变动,不影响代码逻辑。比如删除多余的空白,删除分号等 |
refactor | 重构代码,非bug修复、新增功能和性能优化,包括编码过程中的代码结构调整,不特指重构项目 |
perf | 优化相关,比如提升性能、体验 |
test | 测试用例,包括单元测试、集成测试等 |
build | 构建工具或外部依赖包的修改,比如更新依赖包的版本等 |
ci | 持续集成的配置文件或脚本的修改 |
chore | 杂项,其他不修改源代码与测试代码的修改,例如构建过程或辅助工具的变动 |
revert | 版本回滚或撤销某次提交 |
ignore | 添加忽略 |
merge | 代码合并 |
# 日志类型
主题: 50个字符以内,描述主要变更内容,末尾不要添加结束标点,格式:
[type]:[commit subject]
主体描述: 更详细的说明文本,建议
72
个字符以内。描述信息包括一下几点- 为什么这个变更是必须的? 它可能是用来修复一个bug,增加一个feature,提升性能、可靠性、稳定性等等
- 何解决这个问题? 具体描述解决问题的步骤
- 是否存在副作用、风险?