用于 PR 摘要与代码评审的 AI
提供可直接使用的提示词框架:生成 PR 摘要、识别风险、建议测试用例与回归检查清单。
用于 PR 摘要与代码评审的 AI
目的
本文提供可用于 DeepSeek、Qwen 或其他模型的提示词框架与模板,帮助生成可操作的 PR 摘要、识别风险点、建议测试用例并产出回归检查清单。
通用原则
- 提供上下文:包含 PR 标题、描述、变更文件列表与关键代码片段(或 diff 链接)。
- 明确角色:让模型扮演资深审查者或 QA 工程师。
- 要求结构化输出:列点、风险等级、以及简短的测试建议。
- 控制输出规模:设置最大项数(例如“Top 5 风险”)与输出格式。
提示词框架
1)PR 摘要与影响评估
模板:
“你是资深代码审查员。请用 3–5 条要点总结该 PR:包含意图、关键变更(文件/函数)、行为变更及整体影响。将结果输出为名为 ‘Summary’ 的要点列表。”
可在后续添加:文件清单与 3–4 段代码片段或 diff。
2)风险识别(Top N)
模板:
“扮演一名关注安全的资深工程师。基于该 PR 的上下文,列出前 5 个潜在风险。每项给出:(a)一句话描述、(b)严重性(低/中/高)、(c)一行缓解或检查建议。以编号列表输出。”
3)测试建议与验收标准
模板:
“你是 QA 工程师。为下述 PR 提出最多 8 个测试用例(单元/集成/边界)。每个用例包含:测试名称、简短描述、复现步骤、预期结果。输出 JSON 数组或编号列表。”
4)回归检查清单
模板:
“为该 PR 生成简洁的回归检查清单,覆盖功能、性能、安全与向后兼容性。每项附带通过/不通过的判定标准。最多 10 项。”
5)代码评审注释(聚焦建议)
模板:
“作为资深评审,关注可读性、性能与可维护性。对每个变更文件给出最多 3 条内联建议(格式:文件:行号范围 — 建议 — 理由)。保持建议简短可执行。”
实用示例(合并流程)
“你是资深审查员兼 QA 负责人。基于 PR 标题、描述、变更文件与关键代码片段:1) 生成 4 条 PR 摘要;2) 列出前 5 个风险并给出缓解;3) 提出 6 个测试用例(含步骤与预期);4) 输出 6 项回归清单。请按标题区分段落:SUMMARY、RISKS、TESTS、REGRESSION_CHECKLIST。”
使用建议
- 对大 diff 做分块处理:优先提交关键文件或片段而非完整大 diff。
- 使用检索能力:链接到代码搜索或具体函数以增强结果可靠性。
- 控制详细度:快速筛查时要求短要点,交付给 QA 时请求详细步骤。
- 验证输出:生产相关建议必须由人工核查,尤其是安全/权限相关内容。
可复制提示模板
- PR 摘要:
你是资深代码审查员。用 3–5 条要点总结该 PR:意图、关键变更、行为变化、影响。
PR 标题:<title>
PR 描述:<description>
变更文件:<fileA>, <fileB>, ...
代码片段:<snippet 1> ...
- Top 5 风险:
扮演关注安全的资深工程师。列出该 PR 的前 5 个风险。每项包含描述、严重性(低/中/高)、与缓解建议。
上下文:<paste short context or link>
- 测试用例(JSON):
你是 QA 工程师。返回最多 8 个测试用例的 JSON 数组,字段:name、description、steps(数组)、expected。
上下文:<paste description and key snippets>
何时使用哪种模型
- 快速筛查/高并发:使用优化过的低成本高吞吐模型。
- 深度推理/安全检查:优先使用在链式推理与可解释性上表现更稳定的模型。
结语
这些框架适用于任何 LLM 平台。以简洁、结构化的请求开始,并根据观察到的输出逐步迭代提示。对生产变更,始终保留人工复核流程。