用途:这是一份面向代码变更审查的快速检查清单,目标是在典型 PR 中于 5 分钟内完成聚焦审查。可用于 PR 审查、提交前自查,以及结对编程时的讨论提纲。并非所有条目都适用于每个 PR,小改动可跳过部分类别。
主要能力:按七个维度组织检查项。目的与设计:是否解决正确问题、方案是否匹配问题规模、是否考虑更简单替代、是否符合既有架构。代码质量:命名是否清晰、是否自文档化、职责是否单一、复杂度是否受控、魔法值是否提取为常量。正确性:边界情况、错误处理、异步操作、类型使用、逻辑与需求是否一致。安全:输入校验、密钥管理、认证授权、注入风险。性能:N+1 查询、数据获取效率、重复渲染或计算。测试:关键路径覆盖、测试行为而非实现细节、测试命名清晰。文档:非显然决策的注释、面向用户的文档更新、破坏性变更说明。
使用方式:按类别逐项检查,标记问题并给出改进建议。清单还提供快速决策指南:应立即阻止合并的问题(安全漏洞、数据丢失、无迁移路径的破坏性变更、关键路径逻辑错误);建议修改的问题(命名差、缺少错误处理、新行为无测试、明显性能瓶颈);可选改进(可更简单、命名可更好、可提取辅助函数、可补充测试);以及可批准的小问题(风格偏好、等效替代方案、可选重构)。
限制:资料未提供该清单的安装方式、依赖、平台支持、收费或价格信息,暂未提供。清单本身是审查指导,不替代 CI 测试。