review-checklist.md 3.8 KB

PR Review Checklist

这份清单用于 gh-aw 的 PR review。审查时必须按条目顺序逐条检查,不要跳项,不要合并。

每条规则只允许给出以下四种状态之一:

  • 通过:当前 PR 没看到明显问题
  • 风险:当前 PR 存在明确风险或违反规则
  • 不适用:这条规则与当前改动无关
  • 不确定:证据不足,无法做出强结论

输出时请使用条目编号,不要改编号。

C1. 变更范围与意图是否收敛

  • 检查这次 PR 是否围绕一个清晰目标展开,而不是把多个独立功能、修复、清理、顺手重构打包在一起。
  • 如果代码行为和 PR 标题/描述不一致,按代码行为判断,并指出叙述偏差。
  • 如果看起来是“顺手塞功能”或“把无关改动一起带进来”,标为 风险。

C2. 任务流程是否有明确退出条件

  • 重点看 tasks/**/script_task.py、tasks/**/solo.py 及同类任务入口。
  • 不接受把 sleep 当主控制逻辑,也不接受把 wait_* 伪装成另一种 sleep。
  • 点击、翻页、进入战斗、邀请、退出等流程应有失败重试、超时、异常或显式失败返回。
  • 出现理论上“不应继续执行”的路径时,不能静默卡住。

C3. 是否复用既有组件与全局能力

  • 优先复用现有组件、全局导航、通用战斗、通用邀请、调度逻辑。
  • 如果在任务侧或组件侧重复实现仓库已有能力,标为 风险。
  • 如果改动下沉到 tasks/Component/**、module/**、tasks/GameUi/**,要额外判断它是否真有共享价值。

C4. 页面导航与状态图是否闭环

  • 重点看 tasks/GameUi/**/*.py、tasks/GameUi/page.py、页面 JSON、页面图片与任务入口调用。
  • 新增或修改页面节点时,检查 link 是否有进有出,避免孤立节点。
  • 不要把 page 层扩展成承接过多业务判断的万能层。
  • 页面跳转、关闭弹窗、未知页面回退应优先复用现有 ui_* 体系。

C5. 资源、元数据、图片是否同步

  • 重点看 tasks/**/assets.py、tasks/**/image.json、tasks/**/ocr.json、tasks/**/click.json 与实际 PNG。
  • 不接受半同步状态:只改 assets.py 不改 JSON、只改 JSON 不改图、只换图不改声明。
  • 如果新增图片引用或新增 PNG,要检查是否与 tasks/GlobalGame/**/*.png 下已有素材重复。
  • 对全局通用按钮、确认框、取消框类资源,优先复用全局素材。

C6. 配置字段与翻译是否同步

  • 重点看 tasks/**/config.py、tasks/Component/**/config.py、module/config/**/*.py、config/template.json。
  • 新字段不应只是内部实现细节的外露。
  • 不要扭曲已有字段的既定语义。
  • 如果新增、重命名或删除了 Pydantic 字段,必须检查 assets/i18n/**/*.json 是否同步更新。
  • 如果需要校验器,优先写在对应 config.py 中并补齐必要导入。

C7. 基础层改动是否具有全局收益

  • 重点看 module/atom/**/*.py、module/ocr/**/*.py、module/device/method/**/*.py、tasks/base_task.py。
  • 对基础能力层改动要保守;如果收益只是局部性的,应优先留在任务侧处理。
  • 不要为了单任务、单活动或单场景收益破坏全局兼容性。
  • 涉及截图通道、输入方式、OCR 基础行为时,要特别关注真实运行兼容性。

C8. 依赖与运行材料是否改到真正生效的位置

  • 重点看 requirements.txt、requirements-in.txt、deploy/docker/**/*、bin/droidcast/**/*。
  • 不要只修改中间输入文件而遗漏最终生效文件。
  • 如果 deploy/docker 也维护 Python 依赖或镜像安装项,要把它视为最终生效路径的一部分。
  • 接入包、APK、外部运行材料要以真实可跑为准,而不是只看代码里能 import 或能调用。