MR模板示例
【MR类型】:feature/* | bugfix/* | release/X.Y | dev | main
【简要描述】or 【标题】
新增了xxxxx功能、逻辑... 简要描述MR的主要内容
如果涉及到模块的修改、更新
【修改原因】
为了支持xxxx,需要xxxx...
【修改模块】
xxxx平台------xxx模块
如果涉及到问题单号或者编号
【问题编号】
关联的issue编号, 如 #100
【影响范围】
会影响xxx模块、xxxx模块,...
【新增内容】or 【变更内容】
描述MR中主要的代码变更,包括新增的功能,修改的bug,修改的功能等,可以列出变更的文件如下写法:
- file_path1: file_path
新增一个用于处理xxxxx的模块,实现xxxx逻辑... - file_path2: file_path
新增xxx模块,用于处理异步任务,解析处理数据...进行xx计算...
也可以直接描述变更的内容,如下写法:
- 新增用户登录页面的加载优化功能。
- 修复了用户信息显示不全的问题。
如果你是测试开发,还需要描述测试情况
MR审查规范
- 至少1名同事 approval
- 自动CI Pipeline通过
- 确认已解决所有冲突或者没有冲突
- 所有 discussion resolved
审查内容
代码质量
- 编码规范
- 代码风格
- 命名规范
- 注释要求
功能实现
- 功能覆盖
- 逻辑准确性
- 检查边界条件和异常情况的处理是否完善和考虑周到
测试覆盖率
- 测试用例覆盖
- 测试用例覆盖率和通过率
文档更新
- 确认相关文档(如 用户文档、开发文档、用户手册等)已更新,保持与代码同步
安全性和性能
- 检查代码是否存在安全漏洞
- 确保代码进行了必要的性能优化,避免性能瓶颈
依赖管理
- 确认新增的依赖项已明确列出,并评估对项目的影响