FishBot代码提交消息规范

[小鱼]

FishBot代码提交消息规范

以前小鱼写的commit也不是很规范，趁这次机会也给自己规范一下。

我们采用用的比较多的Angular 规范

git commit -m "<type>(<scope>): <subject>"

其中 type（必选）、scope（可选）和 subject（必选）

Type

• feat：新功能（feature）。
• fix/to：修复bug，可以是QA发现的BUG，也可以是研发自己发现的BUG。
  • fix：产生diff并自动修复此问题。适合于一次提交直接修复问题
  • to：只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
• docs：文档（documentation）。
• style：格式（不影响代码运行的变动）。
• refactor：重构（即不是新增功能，也不是修改bug的代码变动）。
• perf：优化相关，比如提升性能、体验。
• test：增加测试。
• chore：构建过程或辅助工具的变动。
• revert：回滚到上一个版本。
• merge：代码合并。
• sync：同步主线或分支的Bug。

scope(可选)

scope用于说明 commit 影响的范围，比如电机控制层、通信层等等，视项目不同而不同。

例如在FishBot嵌入式中，可以是motors，uart等。如果你的修改影响了不止一个scope，你可以使用*代替。

subject(必选)

subject是commit目的的简短描述，不超过50个字符。

结尾不加句号或其他标点符号。

举个例子
小鱼给FishBot增加了oled支持

git commit -m "feat(peripheral): 增加对OLED驱动的支持"