Code Review

Reviewing Code

Please refer to the following guidelines when reviewing your code before creating pull requests into the master branch from your feature branches.

Implementation

• Does this code change accomplish what it is supposed to do?
• Can this solution be simplified?
• Does this change add unwanted compile-time or run-time dependencies?
• Does similar functionality already exist in the codebase? If yes, why isn’t it reused?
• Are there any best practices, design patterns or language-specific patterns that could substantially improve this code?
• Does this code adhere to Object-Oriented Analysis and Design Principles, like the SOLID?

Error Handling and Logging

• Is error handling done the correct way?
• Are error messages user-friendly?

Dependencies

• Were updates to documentation, configuration, or readme files made as required by this change?
• Are there any potential impacts on other parts of the system or backward compatibility?

Performance

• Do you think this code change decreases system performance?
• Do you see any potential to improve the performance of the code significantly?

Usability and Accessibility

• Is the proposed solution well-designed from a usability perspective?
• Is the proposed solution well documented?
• Is the proposed solution accessible?

Readability

• Is the code easy to understand?
• Which parts were confusing to you and why?
• Would more comments make the code more understandable?
• Could some comments be removed by making the code itself more readable?

---

Page Author: Kyle Robinson