code-review

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Code Review Checklist

代码审查清单

功能

When reviewing code, check each of these areas:
  • 代码实现了PR描述中声明的功能
  • 已处理边界情况
  • 错误处理得当

Functionality

代码质量

  • Code does what the PR description claims
  • Edge cases are handled
  • Error handling is appropriate
  • 遵循项目编码风格指南
  • 不存在应可配置的硬编码值
  • 函数职责单一且命名规范

Code Quality

测试

  • Follows project style guide
  • No hardcoded values that should be configurable
  • Functions are focused and well-named
  • 新功能已配备测试用例
  • 测试用例具备实际意义,而非仅为了覆盖率
  • 现有测试用例仍可正常通过

Testing

安全

  • New functionality has tests
  • Tests are meaningful, not just for coverage
  • Existing tests still pass
  • 代码中未包含凭据或机密信息
  • 用户输入已验证
  • SQL查询已参数化

Security

性能

  • No credentials or secrets in code
  • User input is validated
  • SQL queries are parameterized
  • 无明显性能问题
  • 数据库查询已优化
  • 无不必要的循环或迭代

Performance

文档

  • No obvious performance issues
  • Database queries are optimized
  • No unnecessary loops or iterations
  • 公共API已添加文档
  • 复杂逻辑配有注释说明“原因”
  • 必要时已更新README

Documentation

  • Public APIs are documented
  • Complex logic has comments explaining "why"
  • README updated if needed