用途:用于评审 Pull Request 时的代码质量标准与风格指南,帮助评审者按固定流程检查代码并输出结构化反馈。
主要能力与流程: 第一步检查必须在合并前修复的关键问题,包括逻辑错误与行为不正确、失败场景缺少错误处理、竞态或并发问题、未处理的边界情况(null、undefined、空数组、边界值)、以及无迁移路径的破坏性 API 变更。 第二步评估代码质量:函数应只做一件事且体量合理(建议少于 50 行)、避免重复代码并抽象重复模式、为变量函数类型使用描述性名称、TypeScript 中优先显式类型而非 any、正确使用 async/await(避免悬空 Promise、正确传播错误)。 第三步对照 references/style-guide.md 中的风格指南,检查命名约定、代码组织与导入顺序、注释质量(解释“为什么”而非“做什么”)。 第四步标记特定模式:var(应改为 const 或 let)、遗留的 console.log 或 debugger、被注释掉的代码块、未命名常量的魔法数字、没有关联 issue 的 TODO 或 FIXME 注释。
输出格式:反馈按摘要(1-2 句总体概述与质量评价)、关键问题(必须修复的问题,附文件路径与行号)、建议(可改进项)、正面记录(值得肯定的良好模式与决策)来组织。
限制:资料未提供具体的安装或使用方式,也未说明适用的编程语言范围(仅示例提到 TypeScript),相关细节暂未提供。