SuperAPI AI 工具集

reviewing-code

编程与开发

查看项目

更新于 10-16 03:48

技能介绍

用途:该技能用于代码审查,目标是维护健康代码库并帮助贡献者成功。评审需判断改动是否按正确方向推进项目,即使代码本身完美但功能不被需要也应拒绝,并给出如何对齐项目目标的明确指引。\n\n主要能力:评估改动是否推进代码库;检查依赖版本兼容性,PR 适配新依赖版本时 pyproject.toml 的版本锁定必须匹配,若破坏旧最低版本兼容须提升最低版本,若要向后兼容则用 try/except 或版本检查兼顾两版,仅删除旧 API 而不提升版本锁定是错误的;关注 API 设计与命名,如与默认值矛盾的参数值、可变默认参数、易混淆命名、与代码库不一致的模式;从使用者角度评估易用性与学习曲线;提供具体可执行的改进建议而非泛泛而谈。\n\n使用方式:阅读完整上下文(相关文件、测试、文档)后再评审;对照既有约定检查一致性;核实代码实际行为而非仅看声明;考虑错误条件与边界场景。批准前确认:PR 是否达成其声明目的、目的是否符合代码库方向、是否愿意长期维护、是否真正理解代码行为、是否引入技术债务。检查开发流程步骤(uv sync、prek、pytest)、错误处理是否符合项目模式、测试是否覆盖新功能与边界、API 变更是否有文档且尽量向后兼容。\n\n适用场景:评审拉取请求、评估代码改动、对实现提供反馈、审查贡献代码。\n\n限制与避免事项:避免泛泛反馈、假设性问题、无强理由的组织方式挑剔、复述 PR 已有描述、星级评分或过多表情、功能正确时纠结风格偏好、只要求改动不给方案、以个人风格压过项目约定。语气应直接而尊重,说明影响,肯定好的决策。