SuperAPI AI 工具集

saleor-pr-checklist

编程与开发

查看项目

更新于 10-16 10:22

技能介绍

用途:在打开或更新 Saleor PR 前运行,作为最后的自审关卡,提前发现流程与卫生问题,以及反复出现的评审意见。涉及 schema 或迁移的工作,还应配合 saleor-graphql-api-change 和 saleor-migrations 使用。

流程关卡:运行 pre-commit 并修复其标记的所有问题(格式化、lint、mypy);在请求评审前确保新增或修改的测试在本地通过(运行方法见 AGENTS.md);删除调试与测试脚手架(多余的 str(...) 转换、print、未使用导入);若改动 GraphQL schema,需重新生成 schema.graphql;依赖变更使用固定的 uv 版本,且只改目标依赖,避免 uv.lock 抖动。

CHANGELOG:条目添加到正确的分区/标题下,不要直接追加到文件末尾;绝不为已发布版本添加或编辑条目,已发布修复通过发布说明呈现;changelog 差异应限定在自己的改动范围,不要丢弃无关条目,并校对文字;任何可能对某些 API 消费者造成破坏的行为变更(即使是作为特性引入)都要添加迁移指南条目。

按评审标准自审:通读自己的 diff,对照 AGENTS.md 中常见的评审意见,涵盖测试(精确值断言、否定测试验证副作用未发生、避免断言测试刚设置的值、避免用 copy.deepcopy 掩盖共享输入变更、优先真实 fixture、修复需带回归测试)、分层(业务逻辑放领域层、非 GraphQL 代码不导入 graphql 层、在生产点校验)、数据库与扩展(循环中无 N+1、批量更新删除、只取所需列、任务调度用 on_commit、请求线程不阻塞)、命名(不用晦涩缩写、布尔用肯定式、废弃行为标志加 legacy_ 前缀)、错误处理(具体异常、区分可重试与终态、消息精确并带字段归属)、死代码与类型(删除重构后死代码、在源头修复类型而非 cast())。

PR 描述:说明为什么改,对非显而易见的内容(弃用路径、延迟清理、并发决策)明确写出,并链接任何延后工作的跟踪 issue。

限制:本文档仅描述流程与规范,未提供具体命令、测试运行方式或价格平台信息;安装与运行细节需参考仓库内 AGENTS.md。