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

审查内容

代码质量
  • 编码规范
  • 代码风格
  • 命名规范
  • 注释要求
功能实现
  • 功能覆盖
  • 逻辑准确性
  • 检查边界条件和异常情况的处理是否完善和考虑周到
测试覆盖率
  • 测试用例覆盖
  • 测试用例覆盖率和通过率
文档更新
  • 确认相关文档(如 用户文档、开发文档、用户手册等)已更新,保持与代码同步
安全性和性能
  • 检查代码是否存在安全漏洞
  • 确保代码进行了必要的性能优化,避免性能瓶颈
依赖管理
  • 确认新增的依赖项已明确列出,并评估对项目的影响
相关推荐
仗剑_走天涯9 天前
hadoop 执行mr任务出现找不到主类或无法加载主类解决方案
hadoop·mr
万里长江横渡13 天前
三菱MR-JE系列伺服报警信息查看
制造·mr
源远流长jerry24 天前
RDMA Memory Region (MR) 机制详解:地址转换与内存保护
linux·服务器·网络·tcp/ip·架构·mr
C澒1 个月前
供应链产研交付提效:前端多业务线新增样板间页面统计方案
前端·mr
Sator11 个月前
Unity Pico MR注意事项
mr
weixin_421585012 个月前
如何将论文中的方法推广到脑肿瘤切除手术前的MR图像和切除手术后的超声图像
mr
無森~2 个月前
HBase与MR、Hive整合
hive·hbase·mr
Hody913 个月前
【XR技术介绍】一文理清 OpenVR、OpenXR、SteamVR 与各厂商 SDK等容易混淆的概念
ar·vr·mr
kdyqcsxt663 个月前
MR-H3高速环块磨损试验机
mr
hkNaruto4 个月前
【gitlab】通过 `pre-receive` 钩子控制 MR 合并时的分支路径合并方向,阻止未经允许的合并路径
elasticsearch·gitlab·mr