Presentation explains what is code review, how to do it, shows the a recommended checklist and explains it in details.

1. Code Review
Best Practices
Yevhen Shyshkin

2. Who am I?
Yevhen “Gienek” Shyshkin
● 12+ years of dev experience
● 8+ years in eCommerce
Roles
● Developer
● Tech Writer
● Tech Lead
● Team Lead
● Systems Architect
● Trainer

3. What is Code Review?
● Get a code
● Check a code
● Find a bug
● Report a bug
● ???
● PROFIT!!!

4. Code Review Workflow

5. Why do I need Code Review?
● Better code quality
● Finding defects
● Learning/knowledge transfer
● Increase sense of mutual
responsibility
● Finding better solutions
● Complying to QA guidelines

6. Preparation

7. Preparation
● Investigating the review scope
● Listing most common use cases
● Listing possible bottlenecks
● Creating a checklist of steps to
follow
● Discussing critical issues
● Documenting items

8. Commenting
● Simple, intelligible, and brief
● Precise, explicit, explanatory
● Friendly and positive
● Real communication
● Post review discussion

9. Amount / Time

10. Amount / Time
● 200-400 lines is recommended
● 800 lines is maximum
● Up to 2 consecutive hours
● 200-400 lines per hour
● If you need to review more - split
into smaller pieces

11. Checklist
● Functional Review
● Architectural Review
● Implementation Review
● Automated Tests
● Documentation
https://oroinc.com/downloads/Extensive-Code-Revi
ew-Checklist-by-Oro.pdf

12. Functional Review

13. Functional Review
● Functionality works as described
● Related functionality is identified
and tested
● Manual check throughout the
production environment

14. Architectural Review

15. Architectural Review
● Apply SOLID, KISS, DRY, GRASP
and YAGNI principles
● Functionality is implemented using
relevant architectural design
● No duplicate implementations
● Extensibility points

16. Implementation Review

17. Implementation Review
● Code defects
● Security vulnerabilities
● Memory consumption
● Performance issues (code and
storage)
● Logger

18. Implementation Review
● Boundary values
● Code readability
● Translatable static data
● Docblocks for classes and methods

19. Automated Tests

20. Automated Tests
● Unit tests: class level
● Functional tests: application level
● Functional tests coverage
● Functionality fully covered with
tests

21. Documentation

22. Documentation
● Developer documentation
● Solution extendability
● User documentation code examples

23. Tips and Tricks
● Self-review
● Use IDE-integrable tools
● Fix not found issues
● Describe the issue in maximum
detail
● Fix described and related issues

24. References
https://oroinc.com/orocrm/blog/performing-efficient
-code-review-part-i-best-practices
https://oroinc.com/orocrm/blog/performing-efficient
-code-review-part-ii-checklist
https://oroinc.com/orocrm/blog/performing-efficient
-code-review-part-iii-useful-tips-faq
https://oroinc.com/downloads/Extensive-Code-Revi
ew-Checklist-by-Oro.pdf

25. Q & A