Clean Code Book with corresponding guidelines are found in the Utopia Repository under Documentation.
Code Reviewer's Checklist
Types have been generalized where possible
Parameterized types have been used appropriately
Exceptions have been used appropriately
Repetitive code has been factored out
Frameworks have been used appropriately – methods have all been defined appropriately
Classes have been designed to only have one purpose
Views do not contain business logic
Common errors have been checked for
Potential threading issues have been eliminated where possible
Any security concerns have been addressed
Performance and Scalability was considered
The functionality fits the current design/architecture
The code does not use unjustifiable static methods/blocks
The code complies to coding standards
Logging used appropriately (proper logging level and details)
Exception use is in compliance with proper methodology
Code quality is excellent
Utopia Specific Checklist Items
All code added to UtopiaSharedClasses is safe to expose to customers (No sensitive information)
Libraries or projects that could become Libraries should be stored at the top level of the Utopia Repository
Public API endpoints have documentation comments if needed
Functionality should be exposed at the highest layer of the architecture as possible and only moved down when reuse becomes necessary. (i.e. CSV generation at the presentation layer, but could be moved into business logic if reuse becomes necessary)
No Comments