Code Format

代码提交规范

● 尽可能做到原子化提交

● 尽可能把提交消息写清楚，写明白（把事情做专业）

---

Type

必须是下面的类型之一，不得自己随意发明新类型

● feat: 开发新功能

● fix: 修复 bug

● perf: 提高性能的优化

● refactor: 代码重构，既不修复错误也不添加功能的代码更改

● build: 影响构建系统或外部依赖的更改（比如 package.json，pubspec.yaml, gomod, Podfile,gradle 等等）

● ci: 对CI 配置文件和脚本的更改（比如打包脚本，发布版本记录等）

● doc: 仅文档更改

● style: 不影响代码意义的更改（比如视觉还原）

● test: 单元测试等

● chore：非业务代码的变更，如构建过程或辅助工具的变动。

● revert：用于回滚之前的提交

Scope

根据项目实际情况，按模块划分，模块名尽可能地固定，一以贯之，不要随意的更改 比如模块 “语音转文字”，之前的提交都是“语音转文字”，后面又改成了“speech2text”，或者“ars”，这样就导致历史提交记录的不连贯性。

Fomrat

type(scope): xxxxxx

● type: 全部小写

● scope，中英文均可，不允许有标点符号，特殊字符等

● 冒号：英文半角冒号，后面跟一个空格

● 提交消息：中英文均可，表意清晰，用词准确

示例

● feat(语音转文字): 新增实时语音转文字功能

● feat(灵感流淌): 新增点击图片查看大图

● fix(人像分割): 修复蓝色背景下人物分割后边缘锯齿严重的 bug

● fix(语音转文字): 修复客户端传递非标 language code 导致崩溃的 bug

● perf(人像分割): 优化 png 图片的内存占用

● perf(语音转文字): 优化法语的准确度

● refactor(人像分割): 重构客户端参数校验、鉴权、和请求数据结构等

● doc(人像分割): 增加 image_format 请求参数

● doc(语音转文字): 废弃 language 参数

● style(语音转文字): 优化按钮点击区域，增加阴影效果

反例

● feat(版本 3.0.1): 开发 3.0.1

● fix(bug 修复): 诸多 bug 修复

● refactor(代码重构): 优化项目代码