Code Review 清单

用于规范代码审查流程，保证代码质量和团队一致性。 📄 查看完整 Review 记录示例

基本信息

PR 标题：
作者：
Reviewer：
关联需求/Issue：

一、功能性

[ ] 代码是否满足需求？
[ ] 边界条件是否处理？
[ ] 错误路径是否有处理？
[ ] 是否有足够的单元测试覆盖？

二、可读性与可维护性

[ ] 命名是否清晰、一致？
[ ] 函数是否单一职责？
[ ] 是否有过长函数或过大文件？
[ ] 注释是否必要且清晰？
[ ] 是否避免了魔法数字和硬编码？

三、性能

[ ] 是否有不必要的重新渲染？
[ ] 是否有可优化的循环或递归？
[ ] 图片/资源是否经过优化？
[ ] 是否有不必要的网络请求？
[ ] 大数据量场景是否有分页或虚拟滚动？

四、安全性

[ ] 用户输入是否经过校验和转义？
[ ] 是否避免了 XSS 风险？
[ ] 敏感信息是否未硬编码？
[ ] 权限控制是否正确？

五、类型与规范

[ ] TypeScript 类型是否完整？
[ ] 是否通过 ESLint / Prettier 检查？
[ ] 是否遵循团队代码规范？

六、测试

[ ] 是否有新增或更新测试？
[ ] 测试是否覆盖了核心路径和边界情况？
[ ] 测试是否稳定、可重复？

七、文档

[ ] 是否有必要的代码注释？
[ ] 复杂逻辑是否有说明？
[ ] 公共 API 是否有文档？

八、可观测性

[ ] 关键路径是否有日志或埋点？
[ ] 错误是否有监控上报？
[ ] 性能关键点是否有指标采集？

Review 结论

[ ] 批准（Approve）
[ ] 需要修改（Request Changes）
[ ] 仅评论（Comment）

Reviewer 备注

使用说明：在 PR Review 时复制本清单，逐项检查并记录问题。