寻求Gitlab/Github标准化Issue与MR模板的优质参考示例

一、Merge Request（MR）模板 #

前置检查清单 #

• 是否已合并提交（squash commits）？
• 合并后的提交是否带有标签，比如 [修复]/[维护]/[功能]/[清理]/[升级]？
• 是否为本次MR编写了新的测试用例？
• 测试用例在你的本地环境是否运行成功？

问题说明 #

请详细描述本次MR要解决的问题，包括问题背景、影响范围、触发条件等关键信息。

解决方案说明 #

请阐述本次MR的具体实现方案：

• 核心逻辑改动点
• 涉及的模块或文件
• 关键技术选型（如有）

相关资源链接 #

请提供关联的Issue编号、需求文档、参考资料或其他相关资源。

二、Issue模板 #

问题描述 #

请清晰、具体地描述问题：

• 现象：实际发生的情况
• 场景：问题出现的环境、操作步骤
• 影响：对功能、用户或业务的影响程度

用户故事 #

以用户视角描述需求或问题：

作为[用户角色/身份]，我希望[达成的目标]，以便[获得的价值/解决的痛点]

验收标准 #

列出可验证的验收条件（完成后需全部满足）：

• 条件1：例如“点击按钮后3秒内加载完成数据”
• 条件2：例如“输入非法格式时弹出明确的错误提示”
• 条件3：例如“兼容Chrome 100+、Firefox 98+浏览器”

实现注意事项 #

如果有特定的技术约束、实现建议或需要避免的坑，请在此说明：

• 例如“需复用现有工具类中的校验方法”
• 例如“修改后不能影响A模块的原有功能”

测试注意事项 #

描述测试该Issue时的重点关注内容：

• 测试场景：需要覆盖的操作路径
• 环境要求：特定的系统版本、配置条件
• 特殊步骤：需要模拟的异常情况或边界场景

依赖项 #

列出该Issue依赖的其他任务或资源：

• 例如“需等待#123号Issue完成后才能开始”
• 例如“依赖第三方API的接入文档更新”

参考资源 #

提供有助于理解或解决该Issue的相关资源：

• 设计稿链接（内部）
• 相关技术文档片段
• 类似问题的处理案例

内容的提问来源于stack exchange，提问作者iamsmruti