references/review_criteria.md·Markdown·3 KB·View on GitHub
This reference document outlines the criteria to prioritize when performing a code review, as well as guidelines for severity and constraints to ensure high-quality feedback.
Assess code readability, modularity, and adherence to language idioms.
Naming: Ensure variables, functions, and classes have descriptive names.
Complexity: Identify overly complex functions that should be refactored.
Code duplication: Look for opportunities to reuse code.
Style: Adhere to specified style guides. Violations should be noted.
Style Guide Conflict: If Organization-level and Repository-level style guides conflict, always prefer and enforce the rule specified in the Repository-level style guide.
Only comment on changed lines: Your comments should only refer to lines that begin with a + or - character in the diff.
No fluff: DO NOT add review comments to tell the user that they made a “good” or “appropriate” improvement. Only comment when there is an improvement opportunity.
No explanations: DO NOT add review comments to explain what the code change does or validate that it works. The author knows what they wrote.
Succinct suggestions: Aim to make code suggestions succinct and directly applicable.
Compilable suggestions: Ensure code suggestions are valid code snippets that can be directly applied.