用途
该技能提供一份面向拉取请求(Pull Request)的代码审查检查清单,用于在审查代码时逐项核对,覆盖功能、代码质量、测试、安全、性能和文档等关键维度,帮助审查者系统化地开展审查工作。
主要能力
清单按六个方面组织:
- 功能:代码是否实现 PR 描述所声称的行为;边界情况是否处理;错误处理是否恰当。
- 代码质量:是否遵循项目风格指南;是否存在本应可配置的硬编码值;函数是否职责聚焦且命名良好。
- 测试:新功能是否有测试;测试是否有实际意义而非仅为覆盖率;既有测试是否仍然通过。
- 安全:代码中是否包含凭据或密钥;用户输入是否校验;SQL 查询是否参数化。
- 性能:是否存在明显性能问题;数据库查询是否优化;是否存在不必要的循环或迭代。
- 文档:公共 API 是否文档化;复杂逻辑是否有解释“为什么”的注释;README 是否需要更新。
使用方式
资料未提供具体安装命令、调用方式或集成步骤,暂未提供。从内容看,它是一份审查时逐项对照的清单,可在人工审查或自动化审查流程中作为参考。
适用场景
适用于对拉取请求进行代码审查的环节,尤其是需要覆盖多维度检查、避免遗漏常见问题的团队或个人审查场景。
限制
资料未说明该技能支持的平台、编程语言、自动化程度、收费方式或效果保证,这些信息暂未提供。清单本身为通用性检查项,具体项目可能需要结合自身规范补充或调整。