Effective Code Review
•Download as PPTX, PDF•
2 likes•2,015 views
Code reviews are a great way to build better quality software, help your developers hone their skills, and make a team happier and more productive. Implementing great code review culture takes effort and determination. This presentation offers some pointers to help run better code reviews.
More Related Content
What's hot
What's hot (20)
Viewers also liked
Viewers also liked (20)
Similar to Effective Code Review
Similar to Effective Code Review (20)
More from Jane Prusakova
More from Jane Prusakova (20)
Recently uploaded
Recently uploaded (20)
Effective Code Review
- 6. Judge a coder by the code? Cooperation, not competition Attention is respect Everyone is a reviewer
- 9. Size matters • Consistent criteria • Maintain focus • Be agile • Limit scope • Limit time
- 10. Bucket list Visual layout Naming Architecture Test coverage • Is it readable*? • Is it good maintainable code? • Does it do what it appears to do?
- 11. Skip Explanations what the code does Checks by automated tools Reasons why this code is bad Arguments about preferences*
- 12. Code review is NOT A substitute for the QA A check on automated tools results A discussion on formatting, tools, or patterns
- 13. All code must be perfect? It depends
- 14. Goals of code review Immediate benefit Medium to longer-term improvements Building technical community
- 15. Good Code Worthy of a compliment Bugs Unintended behavior Bad Code Bugs coming soon Erratic code Hard to understand Common Vision -ilities Dependencies Poor scalability
- 16. Code review is not a meeting 0 0.5 1 1.5 2 2.5 3 3.5 4 4.5 Preparation Conversation Follow up Author Reviewer(s)
- 17. Code review is not a meeting 0 0.5 1 1.5 2 2.5 3 3.5 4 4.5 Preparation Conversation Follow up Author Reviewer(s)
- 18. Author Verify test coverage Run code quality tools Fix problems Reviewer Be prepared Learn requirements Read the code Read the tests
- 19. What is readable code? Defined by technology community Common knowledge Expected tenure Popular tools
- 20. Readability Short code blocks Minimize nestedness WYSIWYG
- 21. Show logic One decision per code block Visible assumptions D.R.Y. Test every scenario exactly once
- 22. Naming Make sense Accepted terminology Abbreviations As short as possible but not any shorter Easy to distinguish String result, response, received; Integer value, values; MainClassHelper aHlpr; SituationUtils utils; PersonalDetails personsDetails; PersonalsDetails adCollectionDetails;
- 23. Code quality
- 24. Architecture
- 26. Architecture technical details Standard practices Consistent patterns Reflects requirements Builds on prior knowledge
- 27. Tests All scenarios covered No repetitive tests Robust test structure
- 29. Follow up Review the recommendations Make changes Apply learning Write more code Prepare for the next code review
- 30. It is OK Challenge the advice Do more research Ask for clarification
- 31. Technical Quality Takes time Takes a community Takes iterations Write code Prepare for code review Code review Follow up
- 32. Bugs Unintended behavior Bad Code Bugs coming soon Erratic code Hard to understand Common Vision -ilities Dependencies Poor scalability Good Code Worthy of a compliment
- 33. Code review is like pants. If you work alone, pants are optional. But if you are part of a team, make sure you have pants on.