930 B
930 B
Code Review Guidelines
General Principles
- Write clean, readable, and maintainable code.
- Follow the project's coding standards and style guides.
- Ensure code is well-tested and documented.
- Avoid code duplication; refactor when necessary.
- Use meaningful names for variables, functions, and classes.
- Keep functions and classes focused on a single responsibility.
Specific Checks
- Code follows the project's style guide (e.g., PEP8 for Python).
- No commented-out code or debug prints in production code.
- Proper error handling and logging.
- Resource management (e.g., closing files, releasing network connections).
- Security best practices (input validation, output encoding, etc.).
- Performance considerations (avoid unnecessary loops, optimize database queries).
- Unit tests are present and passing for new code.
- Changes are backward compatible or have a migration plan.