How and When To Code Review
0 likes354 views
The document outlines best practices for code reviews, emphasizing the importance of respect and focus on the code rather than personal critiques. It recommends that reviews should be limited to 200 lines of code in less than 60 minutes, and advocates for the use of checklists and static code analysis tools. Code reviews are shown to significantly enhance defect detection rates compared to unit and integration testing.
How and When To Code Review
- 1. How And When To Code Review Paul Gower @paulmgower
- 2. I’m Paul Gower. Principal Consultant at Lunamark @paulmgower
- 3. AGENDA What Is Code Review1 2 3 How and When Why Code Review
- 4. What Is Code Review 1
- 5. Father of Code Review http://ieeexplore.ieee.org/xpl/articleDetails.jsp?arnumber=5388086&filter%3DAND%28p_IS_Number%3A5388084%29 aka Fagan Inspections
- 6. Fagan Inspections Good for Mission Critical Software
- 11. Email pass-around Please don’t do this!
- 12. Pair Programming
- 22. How and When 2
- 23. How NOT to Code Review
- 26. Reviewer: Focus on the code
- 27. Reviewer: Focus on the code Don’t say: “You didn’t name these variables well!”
- 28. Reviewer: Focus on the code Don’t say: “You didn’t name these variables well!” Instead: “I don’t understand these variable names, can you help me understand them?”
- 30. Reviewer: Find a positive point
- 33. Tips and Tricks
- 34. Less Than 200 Lines Of Code
- 36. Less Than 60 Minutes
- 37. Less Than 60 Minutes http://www.news.illinois.edu/news/11/0208focus_AlejandroLleras.html
- 40. Always Use A Checklist
- 41. Always Use A Checklist http://www.codeproject.com/Articles/593751/Code-Review-Checklist-and-Guidelines-for-Csharp-De
- 42. Don’t Review What Can Be Automated
- 43. Static Code Analysis Tools
- 44. Static Code Analysis Tools
- 45. Static Code Analysis Tools
- 46. Static Code Analysis Tools
- 47. Static Code Analysis Tools
- 48. Static Code Analysis Tools
- 50. “ “…the average defect detection rate is only 25 percent for unit testing, 35 percent for function testing, and 45 percent for integration testing. In contrast, the average effectiveness of design and code inspections are 55 and 60 percent.” - Steve McConnell, Code Complete, 2004
- 52. Before After 2% 55% Code Review Case Studies
- 53. Code Review Case Studies Without With 0.82 errors / 100 loc 4.5 errors / 100 loc
- 56. Reasons to Code Review
- 58. Save Money
- 59. Easier To Find Other’s Mistakes
- 60. Use Peer Pressure To Your Advantage
- 64. “ “The aim is to catch what mistakes you can and to get better – not to attempt perfection.” - Erik Dietrich, “Creating Your Code Review Checklist”, 2015
- 65. Review • No more than 60 mins • No more than 200 lines of code • Use Static Code Analysis • Use Check Lists • Use A Code Review Tool