AI Agent / 系统课时
评审改动并准备交付
评审改动并准备交付
代码通过测试后仍不能直接交付。本课从差异、风险、提交和拉取请求四个层面完成最终评审,确保改动可解释、可回滚,并把未完成事项清楚交给下一位协作者。
学习目标
- 系统检查差异中的功能、安全和兼容性问题
- 整理清晰、可审查的提交记录
- 编写包含验证证据与风险说明的 PR 描述
从完整差异开始评审
先确认工作区只包含本任务改动,再查看相对目标分支的统计和完整差异。不要只阅读 Claude 的总结,因为总结可能遗漏生成文件、配置变化或无关格式化。
bash
# 先检查工作区,再审查相对目标分支的完整差异
git status --short
git diff --stat main...HEAD
git diff --check main...HEAD
git diff main...HEAD预期输出
text
<ONLY_EXPECTED_FILES_CHANGED>
<NO_WHITESPACE_ERRORS>
<FULL_REVIEWABLE_DIFF>目标分支不是 main 时应替换为实际分支。git diff --check 无输出通常表示没有空白错误。
按风险顺序检查
先看安全和数据风险,再看功能正确性,最后看可维护性。重点检查输入校验、权限判断、敏感日志、依赖变化、默认配置、数据库或接口兼容,以及异常路径是否保持原行为。
随后核对每个验收标准是否都能在差异和测试中找到证据。某项只有代码没有测试时,应说明为何无法自动验证,并给出人工步骤。
让 Claude 做第二视角审查
可以让 Claude 在只读模式审查当前分支,但提示词应要求报告具体证据,而不是笼统评价。
bash
# 第二视角只读取差异,不授予仓库工具
git diff main...HEAD |
claude -p \
"审查标准输入中的差异。按严重级别报告功能缺陷、安全问题、兼容性风险和缺失测试;引用文件与差异位置,不要提出无关重构。" \
--tools "" \
--max-turns 3 \
--output-format text预期输出
text
<PRIORITIZED_REVIEW_FINDINGS_OR_NO_BLOCKING_ISSUES>审查结果是补充意见,不替代人工判断。发现问题后应回到实现与测试循环,修复并重新生成完整差异。
整理提交记录
提交应按可独立理解的逻辑组织,不要把探索性修改、生成文件和最终修复混成一个巨大提交。提交信息应说明行为变化,而不是只写“update”或“fix test”。
bash
# 只暂存本任务文件,并生成可理解的提交记录
git add <PATHS>
git commit -m "fix(auth): show credential error on login form"
git log --oneline -3预期输出
text
<COMMIT_ID> fix(auth): show credential error on login form
<PREVIOUS_COMMITS><COMMIT_ID> 和历史记录每次不同。提交前再次确认暂存区没有密钥、日志、临时文件和本地配置。
编写可交付的 PR 说明
PR 描述至少包含问题、方案、范围、验证、风险和后续事项。不要复制整段会话记录,应提炼审查者做决定需要的信息。
markdown
## What changed
- 将 `INVALID_CREDENTIALS` 映射为明确的登录错误文案。
- 保持其他 401 错误处理不变。
- 增加错误映射与登录表单回归测试。
## Validation
- `npm test -- --runInBand <TEST_PATH>`
- `npm test`
- `npm run lint`
- `npm run build`
## Risk and rollback
- 未修改认证接口和锁定策略。
- 如需回滚,可撤销本 PR,不涉及数据迁移。
## Follow-up
- 后续补充其他语言资源,由独立任务跟踪。生效结果
text
审查者能够从 PR 描述中确认行为变化、验证证据、风险边界和回滚方式。完成交付门禁
交付前最后检查 CI 全部通过、分支已同步目标分支、阻塞评论已解决、文档与发布说明已更新。若仍有已知问题,必须标注责任人和跟踪入口,不能只写“以后处理”。
按自己的节奏,确认真正理解。