Git提交信息格式

程序员文章站 2022-07-13 08:06:18

...

提交的时机

每当完成了一个新功能、修复了一个错误、重构一个模块或者调整格式时，都应该提交（commit）一次代码，以便版本工具记录这次修改。

规定：不能将不相关的修改一块提交，混合不同的功能会使得以后的问题查找或者其他成员浏览历史变得困难。

<type>: <subject>
//空一行
<body>

type：用于说明本次提交的类别，规定为以下几种：
- feat：新功能
- fix：修复错误
- refactor：重构代码
- style：调整代码格式（不影响代码运行）
- docs：更新了文档
subject：提交的简要说明，尽量简明扼要。

规定：简要说明的内容不大于90个字符。

规定：subject之前有一个空格。在浏览有很多条提交信息的历史记录时，多出的这个空格，可以更容易的查看提交说明。
body：对本次提交的详细描述，可以分多行。
规定：body之前有一个空行，这是为了在浏览日志中只显示提交的简要说明。

规定：如果type是fix(修复错误)，必须在body中记录以下信息：
1. 重现错误的完整步骤；
2. 预期应有的行为
3. 观察到的错误行为
当提交的简要说明已经能完整描述本次提交时，body部分可以省略。

修复错误

fix: 修复四舍五入失效问题

传感器接入系统，当传感器显示值为6ppm时，观察上位机的显示值
此时两者误差不应大于0.5ppm，观察到两者误差为1ppm
原因：当放大倍数为1时，值转频率或频率转值实际上没有进行四舍五入。

新增加功能

feat: 新增高级巡检命令（0x56）