器库yueser.com

请求评审时给足上下文

收录 2026-11-04

改了什么、为什么、哪里最需要看,先说清楚。

我要请同事评审一段代码(情况稍后给你)。请写评审请求:1)一句话说明目的与改动范围;2)为什么这样设计(考虑过的替代方案);3)希望重点看的三处;4)已知的风险或未完成项;5)如何验证/复现;6)说明这次不需要关注什么(格式、命名)。不超过 150 字,适合直接贴在 PR 描述。
本站原创

中文原文

使用建议

评审请求写得越具体,收到的意见越有用。

可以这样改

  • 要求它先复述需求与约束,确认无误再写代码。
  • 让它给出最小改动 + 回滚方式,而不是整文件重写。

交付物(这次应拿到什么)

  • 可运行的最小改动(含直接可用的代码块)
  • 影响面清单:改了哪些文件、哪些调用点要跟着改

常见错法

  • 一次让它改十个文件,最后分不清哪处改动导致了新问题。
  • 只贴报错不贴代码和版本,拿到无法落地的修法。

输出验收(怎么判断能用)

  • 改动可运行、可回滚,且没顺手改无关代码。
  • 边界条件(空值、超长、并发)有说明或测试。

适用场景与注意

  • 适合:让它先复述需求和约束,再给最小可运行改动。
  • 注意:贴报错时同时给版本号与最小复现,否则它容易给出看似合理但不适配的写法。

所属合集

同方向的其他提示词