SuperAPI AI Directory

code-review

Testing & quality

View repository

Updated 10-16 06:23

About this skill

Code Review Skill Pack

When conducting code reviews, please follow the professional guidelines and checklist below.

Review Checklist

1. Code Quality

  • Coding Standards: Does the code follow the project's coding standards and style guide
  • Naming Conventions: Are variable, method, and class names clear, easy to understand, and semantically appropriate
  • Code Duplication: Is there duplicated code, and can common methods or utility classes be extracted
  • Clear Logic: Is the code logic concise and clear, avoiding overly complex nesting and conditional branches
  • Comment Quality: Is there appropriate commenting for key logic, and are the comments accurate and effective

2. Potential Issues

  • Null Pointer Safety: Are objects that may be null handled correctly
  • Boundary Conditions: Are array and list accesses checked for bounds, and are loop boundaries correct
  • Exception Handling: Are exceptions properly caught and handled, and are there any swallowed exceptions
  • Concurrency Safety: Are there race conditions or deadlock risks in a multithreaded environment
  • Resource Leaks: Are resources such as files, connections, and streams properly closed

3. Performance Considerations

  • Algorithm Efficiency: Are appropriate algorithms and data structures used
  • Database Queries: Are there N+1 query issues, and can the SQL be optimized
  • Memory Usage: Are there risks of memory leaks, and are large objects released promptly
  • Loop Optimization: Are there unnecessary repeated calculations or object creations in loops

4. Security

  • Input Validation: Is user input fully validated and filtered
  • SQL Injection: Do database queries use parameterized queries to prevent injection
  • Sensitive Information: Are sensitive information such as passwords and keys stored encrypted
  • Access Control: Are there appropriate permission checks and access controls

5. Test Coverage

  • Unit Tests: Is there corresponding unit testing for key logic
  • Boundary Testing: Are boundary conditions and exceptional cases tested
  • Test Quality: Are the test cases effective, and can they truly verify functionality

Review Output Format

Please output the review results in the following structured format:

Critical Issues(if any):

  • [File Name:Line Number] Problem description and risk explanation

Improvement Suggestions:

  • [File Name:Line Number] Specific improvement suggestions and recommended practices

Strengths:

  • Code design and implementation highlights worth recognizing

Overall Assessment: Briefly summarize code quality and suggestions

Review Principles

  1. Constructive Feedback: Provide specific improvement suggestions while raising issues
  2. Objective and Fair: Base feedback on standards and best practices, and avoid subjective assumptions
  3. Clear Priorities: Distinguish between serious issues and improvement suggestions
  4. Example code: Provide improved example code when necessary