PR review checklist¶
-
Read through the PR description: Understand the purpose of the PR and the changes that have been made.
-
Check the changes: Review the code changes, including the addition, modification, and removal of files, and ensure they are in line with the project requirements.
-
Test the changes: Run the code and test the changes in a local environment or staging environment, to verify that they work as expected.
-
Check for code quality: Verify that the code adheres to the project's coding standards and best practices, including naming conventions, code style, and commenting standards.
-
Check for security vulnerabilities: Ensure that the code does not introduce any security vulnerabilities, such as SQL injection, cross-site scripting, or cross-site request forgery.
-
Review for performance: Check the performance of the code and ensure that it is optimized for speed and scalability.
-
Consider the impact of the changes: Evaluate the impact of the changes on the existing codebase and ensure that they do not cause any unintended consequences.
-
Check for documentation: Ensure that the code changes are adequately documented, including in-line comments, readme files, or project wikis.
-
Provide feedback: Give constructive feedback on the changes made, including suggestions for improvement and potential issues that need to be addressed.
-
Approve or reject the PR: Based on your review, approve or reject the PR and provide relevant comments.