代码提交的一些建议

2025-04-15, by alamide

代码提交的一些建议、规范。

一、代码提交需要规范的原因

1. 方便团队协作，便于其它开发者清楚了解本次代码提交的意图，也方便后续工作交接。

2. 代码出现问题时便于自己找出问题所在。

3. 便于代码回溯。

二、提交的基本原则

1. 分功能多次提交，尽可能每次提交的工作是一个完整、独立的任务，避免一次提交“一堆”任务。

2. 提交的信息需清晰表明本次任务完成的种类、完成进度及其它必要信息。

三、推荐以本次任务完成类别的单词或缩写开头，后接冒号，再之后为具体进一步的说明

示例:

1. 新功能(feature/feat)

2. 优化(optimize/opt)

3. 修复BUG(fix)

4. 代码重构(refactor)

5. 冗余资源删除(delete)，这也可以归拢到优化类别

6. 修改(modify)，如修改版本号、keystore 等与代码无关的信息

7. 代码合并(merge)

四、提交示例

1. 新需求、新功能
   feature: 本次完成 xxx 功能

2. 修复 BUG
   fix: 修复 xxx 问题，出现这个问题的原因是 xxx

3. 优化UI、算法等
   optimize: 优化 xxx 功能，优化的原因是 xxx，本次优化提升了 xxx

4. 代码重构
   refactor: 重构了 xxx 部分的代码，重构的原因是 xxx