MR模板以及代码审查规范

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

审查内容

代码质量
  • 编码规范
  • 代码风格
  • 命名规范
  • 注释要求
功能实现
  • 功能覆盖
  • 逻辑准确性
  • 检查边界条件和异常情况的处理是否完善和考虑周到
测试覆盖率
  • 测试用例覆盖
  • 测试用例覆盖率和通过率
文档更新
  • 确认相关文档(如 用户文档、开发文档、用户手册等)已更新,保持与代码同步
安全性和性能
  • 检查代码是否存在安全漏洞
  • 确保代码进行了必要的性能优化,避免性能瓶颈
依赖管理
  • 确认新增的依赖项已明确列出,并评估对项目的影响
相关推荐
世优科技虚拟人2 天前
VR大空间成文旅研学新宠:山海经、西游记、吴哥窟三大IP项目实探
vr·mr·虚拟体验·vr大空间
无聊的老谢4 天前
基于 Spring Batch 的电信 MR 数据亿级记录清洗实战
spring·batch·mr
2601_961875247 天前
高考真题word版下载|2025高考全科真题可编辑文档
c#·word·ar·vr·mr·高考·oneflow
2601_961845428 天前
2027考研数学大纲|数一数二数三
考研·fpga开发·ar·vr·mr·oneflow
2601_9571909011 天前
超元力mr无限飞车:虚实融合竞速体验,重构线下娱乐消费新生态
重构·娱乐·mr
2601_9571909012 天前
超元力mr卡丁车:轻量化落地运营,适配中大型场地的新型游乐业态
大数据·人工智能·mr
HEADKON20 天前
英菲格拉替尼治疗胆管癌FGFR2融合患者的客观缓解率
mr
2601_957190901 个月前
MR卡丁车:虚实融合,重新定义线下竞速娱乐新体验
娱乐·mr
水火既济__1 个月前
大数据hive_mr压缩问题
大数据·hive·mr
郑寿昌1 个月前
2026年MR交互革命:事件相机重塑手势眼动同步
数码相机·mr