Code reviews are an opportunity to share knowledge and make informed engineering decisions. Its process aims to ensure that the delivered code meets the story’s Acceptance Criteria and that the codebase stays consistent, maintainable, and understandable. The goal is not to find the “perfect” code; there is only better code. The author should be considerate of the reviewer's time by carefully preparing the PR and replying to comments in a timely manner. The reviewer should balance the need to progress forward with the importance of the suggested changes at any given time.

The purpose of code review guidelines is to provide a clear and consistent process for reviewing code. Code review guidelines help ensure that code is reviewed thoroughly and consistently, and that feedback is constructive and actionable.

Here are some of the key benefits of having code review guidelines:

• Consistency: Guidelines help ensure that all code is reviewed in a consistent manner, regardless of who is doing the reviewing. This can help ensure that issues and potential improvements are caught early and addressed before they become larger problems.
• Efficiency: Guidelines can help make the review process more efficient by providing a clear framework for reviewing code. This can help reviewers focus on the most important aspects of the code and avoid getting bogged down in minor details.
• Quality: By providing guidelines for code quality, the review process can help ensure that code is of a high quality and meets the standards of the project.
• Learning: Guidelines can help reviewers learn from each other and improve their skills over time. By providing feedback and discussing code with other reviewers, everyone involved in the review process can learn from each other and improve their understanding of best practices and coding standards.

Overall, code review guidelines help ensure that code is reviewed thoroughly and consistently, and that feedback is constructive and actionable. This can help improve the quality of code and ensure that the project as a whole is successful.

Summary

As the author of the pull request you should make sure to:

• Review and check that the code compiles without errors or warnings.
• Ensure that all new code is covered by unit tests and existing tests are still passing.
• Your code follows the project’s coding standards and style guidelines.
• Test the code to ensure that it works as intended.
• Confirm that any related documentation has been updated to reflect the changes made.