This guide is intended to help our software development teams conduct effective code reviews that improve code quality and ensure consistency. It is a reference document for our engineers to follow as they review code.
The author must follow the project's coding standards and best practices. This helps ensure that the code is consistent and easy to read and maintain.
<aside> 💡 Establishing and practicing proper conventions helps in ensuring best practices are followed by default as a habit and never missed out.
</aside>
The author must test the code to ensure that it functions as intended and that all edge cases are handled correctly.
<aside> 💡 For Example, please refer to Unicache’s test cases. These test cases ensure 90%+ code coverage.
</aside>
The author must use version control tools effectively, making sure that the changes are properly tracked and documented.
<aside> 💡 Create independent GIT branches for tasks, test them, and merge them back to the sprint branch after code review. This ensures that code changes are reviewed before being merged into the main codebase.
</aside>
The author must provide documentation for the change, including any changes to APIs, interfaces, or user-facing functionality.
Provide a clear description of the change
The author must provide a clear and concise description of the change they are making. This helps reviewers understand the purpose and scope of the change. Please refer to best practices for more details and instructions.
The author must collaborate with other team members to ensure that the change is consistent with the overall architecture and design of the codebase. Please refer to communication and tools guidelines for more details.
The author must follow the project’s change management process, including obtaining appropriate approvals and notifying relevant stakeholders. Please note, each client may have specific processes. Always make sure to learn about them during the project onboarding phase.