Effective codereview | Dave Liddament | CODEiD
0 likes93 views
Dave Liddament - международный спикер и разработчик в Lamp Bristol. Мы пригласили его выступить у нас на конференции 8 декабря с темой «Effective Code Review». ⠀ There are so many benefits from code review; lower development costs, increased code quality, quick up-skilling and on-boarding of team members. Despite these benefits many teams don’t have code review as part of their process at all. Others don’t get the gains they should from it. ⠀ This talk first outlines the business case for code review. It then explores how to make code review effective, specifically looking at: ⠀ • Expectations of what can be achieved with code review. • What should be covered by code review (including example code) • What should not be covered by code review • How to write code that makes code review easy • What makes good code review comments • What makes good responses to code review comments ⠀ Finally to wrap up you'll be shown how to enable a code review with Github. Spoiler alert: It can be done it under 5 mins!So if you are on a team that isn’t using code review, or isn’t using it effectively then you should be at this talk. CODEiD – это всеукраинское сообщество PHP-разработчиков. Наша цель — создать сильное сообщество всех, кто увлечен PHP-разработкой, и принимать в нашем уютном приморском городе коллег со всей Украины и мира.
![@daveliddament
CODE REVIEW BENEFITS
WHAT ARE DEFECTS?
Bugs
Evolvability [1, 2]](https://image.slidesharecdn.com/effectivecodereviewcodeid2-190221130851/85/Effective-codereview-Dave-Liddament-CODEiD-21-320.jpg)
![@daveliddament
CODE REVIEW BENEFITS
EVOLVABILITY IS IMPORTANT
▸ Low evolvability costs money:
▸ New features took 28% longer to implement [3]
▸ Fixing bugs took 36% longer [3]
▸ Software structure may account for 25% of total maintenance
costs [4]](https://image.slidesharecdn.com/effectivecodereviewcodeid2-190221130851/85/Effective-codereview-Dave-Liddament-CODEiD-22-320.jpg)
![@daveliddament
CODE REVIEW BENEFITS
YOU’RE BEING WATCHED!
[5]](https://image.slidesharecdn.com/effectivecodereviewcodeid2-190221130851/85/Effective-codereview-Dave-Liddament-CODEiD-45-320.jpg)
![@daveliddament
“THE RATIO OF TIME SPENT READING VERSUS WRITING
IS WELL OVER 10 TO 1. WE ARE CONSTANTLY READING
OLD CODE AS PART OF THE EFFORT TO WRITE NEW
CODE. …
[THEREFORE,] MAKING IT EASY TO READ MAKES IT
EASIER TO WRITE.”
Robert C. Martin (Clean Code)
COST OF WRITING CODE CODE](https://image.slidesharecdn.com/effectivecodereviewcodeid2-190221130851/85/Effective-codereview-Dave-Liddament-CODEiD-63-320.jpg)
![@daveliddament
WILL I UNDERSTAND THE CODE IN 6 MONTHS TIME?
WHAT DOES THIS CODE DO?
$userFields = [
'Username',
'Email',
'FirstName',
'LastName',
'Phone',
];
foreach ($userFields as $key) {
if ($userDetails->{'get'.$key}()) {
$user->{'set'.$key}($userDetails->{'get'.$key}());
}
}](https://image.slidesharecdn.com/effectivecodereviewcodeid2-190221130851/85/Effective-codereview-Dave-Liddament-CODEiD-64-320.jpg)
![@daveliddament
CODE REVIEW TIPS
HOW MUCH SHOULD YOU REVIEW IN ONE GO?
▸ Fewer than 400 lines of code at a time [6]
▸ Under 500 line of code reviewed per hour [6]
▸ Max 1 hour review at a time [6]](https://image.slidesharecdn.com/effectivecodereviewcodeid2-190221130851/85/Effective-codereview-Dave-Liddament-CODEiD-103-320.jpg)
![@daveliddament
WRAP UP
WHAT ARE DEFECTS?
Bugs
Evolvability [1, 2]](https://image.slidesharecdn.com/effectivecodereviewcodeid2-190221130851/85/Effective-codereview-Dave-Liddament-CODEiD-139-320.jpg)
![@daveliddament
WRAP UP
YOU’RE BEING WATCHED!
[5]](https://image.slidesharecdn.com/effectivecodereviewcodeid2-190221130851/85/Effective-codereview-Dave-Liddament-CODEiD-143-320.jpg)
![@daveliddament
REFERENCES
REFERENCES
▸ [1] Mika V. Mantyla and Casper Lassenius “What Types of Defects Are Really
Discovered in Code Reviews?” IEEE Transactions on Software Engineering
▸ [2] Harvey Siy, Lawrence Votta “Does The Modern Code Inspection Have Value?”
▸ [3] R.K. Bandi, V.K. Vaishnavi, and D.E. Turk, “Predicting Maintenance
Performance Using Object-Orientated Design Complexity Metrics”
▸ [4] R.D. Banker, S.M. Datar, C.F. Kemerer, and D. Zweig, “Software Complexity
and Maintenance Costs,”
▸ [5] https://www.bbc.co.uk/news/uk-37502136
▸ [6] https://smartbear.com/learn/code-review/best-practices-for-peer-code-
review/](https://image.slidesharecdn.com/effectivecodereviewcodeid2-190221130851/85/Effective-codereview-Dave-Liddament-CODEiD-150-320.jpg)
More Related Content
Similar to Effective codereview | Dave Liddament | CODEiD (20)
More from CODEiD PHP Community (11)
Recently uploaded (20)
![Get & Download Wondershare Filmora Crack Latest [2025]](https://cdn.slidesharecdn.com/ss_thumbnails/revolutionizingresidentialwi-fi-250422112639-60fb726f-250429170801-59e1b240-thumbnail.jpg?width=560&fit=bounds)
Effective codereview | Dave Liddament | CODEiD
- 1. Effective Code Review Dave Liddament
- 2. @daveliddament WHY THIS TALK? EFFECTIVE CODE REVIEW REDUCES OVERALL COST OF SOFTWARE DEVELOPMENT
- 3. @daveliddament COST OF A BUG Cost DESIGN WRITING CODE TEST RELEASE MAINTENANCE FIND BUGS SOONER
- 4. @daveliddament COST OF A BUG Cost DESIGN WRITING CODE TEST RELEASE MAINTENANCE FIND BUGS SOONER
- 5. @daveliddament Dave Liddament Lamp Bristol Organize: - PHP-SW user group - Bristol PHP Training @daveliddament
- 6. @daveliddament EFFECTIVE CODE REVIEW AGENDA ▸ Why ▸ Code quality ▸ What is code review ▸ Benefits ▸ Implementation ▸ Tips ▸ Integrating code review into project workflow
- 7. @daveliddament CODE QUALITY EFFECTIVE CODE REVIEW REQUIRES…
- 8. @daveliddament CODE QUALITY EFFECTIVE CODE REVIEW REQUIRES…
- 9. @daveliddament CODE QUALITY EFFECTIVE CODE REVIEW REQUIRES…
- 10. @daveliddament CODE QUALITY EFFECTIVE CODE REVIEW REQUIRES…
- 11. @daveliddament CODE REVIEW IS THE SYSTEMATIC EXAMINATION OF SOURCE CODE… Wikipedia WHAT IS CODE REVIEW
- 12. @daveliddament IT IS INTENDED TO FIND MISTAKES OVERLOOKED IN SOFTWARE DEVELOPMENT, IMPROVING THE OVERALL QUALITY OF SOFTWARE. Wikipedia WHAT IS CODE REVIEW
- 13. @daveliddament WHAT IS CODE REVIEW HOW IS IT DONE
- 14. @daveliddament WHAT IS CODE REVIEW HOW IS IT DONE
- 15. @daveliddament WHAT IS CODE REVIEW HOW IS IT DONE
- 17. @daveliddament CODE REVIEW BENEFITS WHAT ARE DEFECTS?
- 18. @daveliddament CODE REVIEW BENEFITS WHAT ARE DEFECTS? Bugs
- 19. @daveliddament CODE REVIEW BENEFITS WHAT ARE DEFECTS? Bugs Evolvability
- 20. @daveliddament CODE REVIEW BENEFITS AN EVOLVABILITY DEFECT IS… Code that makes code base less compliant with standards, more error prone, or more difficult to modify, extend or understand.
- 21. @daveliddament CODE REVIEW BENEFITS WHAT ARE DEFECTS? Bugs Evolvability [1, 2]
- 22. @daveliddament CODE REVIEW BENEFITS EVOLVABILITY IS IMPORTANT ▸ Low evolvability costs money: ▸ New features took 28% longer to implement [3] ▸ Fixing bugs took 36% longer [3] ▸ Software structure may account for 25% of total maintenance costs [4]
- 23. @daveliddament CODE REVIEW BENEFITS COST TO DEVELOP SIMILAR SIZED FEATURE OVER TIME
- 24. @daveliddament CODE REVIEW BENEFITS Cost Time into project COST TO DEVELOP SIMILAR SIZED FEATURE OVER TIME
- 25. @daveliddament CODE REVIEW BENEFITS Cost Time into project COST TO DEVELOP SIMILAR SIZED FEATURE OVER TIME
- 26. @daveliddament CODE REVIEW BENEFITS Cost Time into project COST TO DEVELOP SIMILAR SIZED FEATURE OVER TIME
- 27. @daveliddament CODE REVIEW BENEFITS TAKE AWAY ▸ The majority of code review comments will not be “bugs”. ▸ Most comments will be code improvements. ▸ Lower technical debt. Lower overall cost. ▸ Studies back this up. ▸ Remember to sell the right metric to management.
- 28. @daveliddament CODE REVIEW BENEFITS SECURITY REVIEW
- 29. @daveliddament CODE REVIEW BENEFITS SECURITY REVIEW ▸ Writing sensitive data to logs (e.g. password)
- 30. @daveliddament CODE REVIEW BENEFITS SECURITY REVIEW ▸ Writing sensitive data to logs (e.g. password) ▸ Bugsnag / error log reporting
- 31. @daveliddament CODE REVIEW BENEFITS SECURITY REVIEW ▸ Writing sensitive data to logs (e.g. password) ▸ Bugsnag / error log reporting ▸ Files that shouldn’t be there? (e.g. malware)
- 32. @daveliddament CODE REVIEW BENEFITS SECURITY REVIEW ▸ Writing sensitive data to logs (e.g. password) ▸ Bugsnag / error log reporting ▸ Files that shouldn’t be there? (e.g. malware) ▸ OWASP top 10
- 33. @daveliddament CODE REVIEW BENEFITS SECURITY REVIEW ▸ Writing sensitive data to logs (e.g. password) ▸ Bugsnag / error log reporting ▸ Files that shouldn’t be there? (e.g. malware) ▸ OWASP top 10 ▸ OWASP top 10 cheat sheet
- 34. @daveliddament CODE REVIEW BENEFITS SECURITY REVIEW ▸ Writing sensitive data to logs (e.g. password) ▸ Bugsnag / error log reporting ▸ Files that shouldn’t be there? (e.g. malware) ▸ OWASP top 10 ▸ OWASP top 10 cheat sheet ▸ Not / weakly hashing passwords
- 35. @daveliddament CODE REVIEW BENEFITS SECURITY REVIEW ▸ Writing sensitive data to logs (e.g. password) ▸ Bugsnag / error log reporting ▸ Files that shouldn’t be there? (e.g. malware) ▸ OWASP top 10 ▸ OWASP top 10 cheat sheet ▸ Not / weakly hashing passwords ▸ Rolled your own authentication / hashing / encryption algorithms
- 36. @daveliddament CODE REVIEW BENEFITS SPREAD THE KNOWLEDGE
- 37. @daveliddament CODE REVIEW BENEFITS NO MORE SILOS
- 38. @daveliddament CODE REVIEW BENEFITS NO MORE SILOS XXX
- 39. @daveliddament CODE REVIEW BENEFITS NO MORE SILOS XXX
- 40. @daveliddament CODE REVIEW BENEFITS NO MORE SILOS XXX
- 41. @daveliddament CODE REVIEW BENEFITS NO MORE SILOS XXX
- 43. @daveliddament CODE REVIEW BENEFITS Rateofintroducingbugs Experience / Skill SKILL AND EXPERIENCE VS BUGS
- 44. @daveliddament CODE REVIEW BENEFITS YOU’RE BEING WATCHED!
- 45. @daveliddament CODE REVIEW BENEFITS YOU’RE BEING WATCHED! [5]
- 46. @daveliddament CODE REVIEW BENEFITS BENEFITS ▸ Reduce defects ▸ Studies that back this up ▸ Find security vulnerabilities ▸ Spread knowledge ▸ Mentoring ▸ Peer pressure improves code quality
- 47. @daveliddament EFFECTIVE CODE REVIEW REDUCES OVERALL COST OF SOFTWARE DEVELOPMENT
- 52. @daveliddament IMPLEMENTATION WE CAN AUTOMATE ▸ Tests ▸ Code style (php-cs-fixer)
- 53. @daveliddament IMPLEMENTATION WE CAN AUTOMATE ▸ Tests ▸ Code style (php-cs-fixer) ▸ Lint (php, yaml, twig, doctrine, composer)
- 54. @daveliddament IMPLEMENTATION WE CAN AUTOMATE ▸ Tests ▸ Code style (php-cs-fixer) ▸ Lint (php, yaml, twig, doctrine, composer) ▸ Static analysis (Psalm, PHPStan, Phan)
- 55. @daveliddament IMPLEMENTATION WE CAN AUTOMATE ▸ Tests ▸ Code style (php-cs-fixer) ▸ Lint (php, yaml, twig, doctrine, composer) ▸ Static analysis (Psalm, PHPStan, Phan) ▸ 3rd party security checks (sensiolabs/security-checker)
- 56. @daveliddament IMPLEMENTATION DO THE TESTS TEST THE REQUIRED FUNCTIONALITY
- 57. @daveliddament IMPLEMENTATION DO THE TESTS TEST THE REQUIRED FUNCTIONALITY Input Expected Output my blog my-blog hello Dave hello-Dave
- 58. @daveliddament IMPLEMENTATION DO THE TESTS TEST THE REQUIRED FUNCTIONALITY Input Expected Output my blog my-blog hello Dave hello-Dave
- 59. @daveliddament IMPLEMENTATION ARE THE TESTS ADEQUATE
- 60. @daveliddament IMPLEMENTATION ARE THE TESTS ADEQUATE Input Expected Output my blog my-blog it’s Saturday its-saturday
- 61. @daveliddament IMPLEMENTATION HOW MANY TESTS DO WE NEED? /** * @param int $id * @return bool * @throws NotFoundException */ public function isAllowed(int $id): bool { .. some implementation .. } /** * @param int $id * @return bool * @throws NotFoundException */ public function isAllowed(int $id): bool { .. some implementation .. }
- 62. @daveliddament IMPLEMENTATION WILL I UNDERSTAND THIS CODE IN 6 MONTHS TIME?
- 63. @daveliddament “THE RATIO OF TIME SPENT READING VERSUS WRITING IS WELL OVER 10 TO 1. WE ARE CONSTANTLY READING OLD CODE AS PART OF THE EFFORT TO WRITE NEW CODE. … [THEREFORE,] MAKING IT EASY TO READ MAKES IT EASIER TO WRITE.” Robert C. Martin (Clean Code) COST OF WRITING CODE CODE
- 64. @daveliddament WILL I UNDERSTAND THE CODE IN 6 MONTHS TIME? WHAT DOES THIS CODE DO? $userFields = [ 'Username', 'Email', 'FirstName', 'LastName', 'Phone', ]; foreach ($userFields as $key) { if ($userDetails->{'get'.$key}()) { $user->{'set'.$key}($userDetails->{'get'.$key}()); } }
- 65. @daveliddament WILL I UNDERSTAND THE CODE IN 6 MONTHS TIME? WHAT DOES THIS CODE DO? (2) if ($userDetails->getUsername()) { $user->setUsername($userDetails->getUsername()); } if ($userDetails->getEmail()) { $user->setEmail($userDetails->getEmail()); } if ($userDetails->getFirstName()) { $user->setFirstName($userDetails->getFirstName()); } if ($userDetails->getLastName()) { $user->setLastName($userDetails->getLastName()); } if ($userDetails->getPhone()) { $user->setPhone($userDetails->getPhone()); }
- 66. @daveliddament WILL I UNDERSTAND THE CODE IN 6 MONTHS TIME? /** * Represents a location in the UK. *(eg city, town, village) */ class Location { /** * @return string URL */ public function getUrl(): string { return $this->url; }
- 67. @daveliddament WILL I UNDERSTAND THE CODE IN 6 MONTHS TIME? WHAT IS URL? /** * Represents a location in the UK. *(eg city, town, village) */ class Location { /** * @return string URL */ public function getUrl(): string { return $this->url; }
- 68. @daveliddament WILL I UNDERSTAND THE CODE IN 6 MONTHS TIME? WHAT IS URL? /** * Represents a location in the UK. *(eg city, town, village) */ class Location { /** * @return string URL */ public function getUrl(): string { return $this->url; }
- 69. @daveliddament WILL I UNDERSTAND THE CODE IN 6 MONTHS TIME? if ($agent->getType() === 1) { … do something … }
- 70. @daveliddament WILL I UNDERSTAND THE CODE IN 6 MONTHS TIME? WHAT DOES 1 MEAN? if ($agent->getType() === 1) { … do something … }
- 71. @daveliddament IS THE CODE AS OBVIOUS AND EXPLICIT AS IT POSSIBLY CAN BE HOW DO WE MAKE THIS MORE OBVIOUS class MarketingCampaign { public function addAddress($address) { .. some implementation .. } }
- 72. @daveliddament IS THE CODE AS OBVIOUS AND EXPLICIT AS IT POSSIBLY CAN BE HOW DO WE MAKE THIS MORE OBVIOUS (2) class MarketingCampaign { public function addEmailAddress($emailAddress) { .. some implementation .. } }
- 73. @daveliddament IS THE CODE AS OBVIOUS AND EXPLICIT AS IT POSSIBLY CAN BE HOW DO WE MAKE THIS MORE OBVIOUS (3) class MarketingCampaign { /** * Adds email address, person will then be * messaged as part of the campaign. */ public function addEmailAddress($emailAddress) { .. some implementation .. } }
- 74. @daveliddament IS THE CODE AS OBVIOUS AND EXPLICIT AS IT POSSIBLY CAN BE HOW DO WE MAKE THIS MORE OBVIOUS (4) class MarketingCampaign { /** * Adds email address, person will then be * messaged as part of the campaign. */ public function addEmailAddress( string $emailAddress): void { .. some implementation .. } }
- 75. @daveliddament IS THE CODE AS OBVIOUS AND EXPLICIT AS IT POSSIBLY CAN BE HOW DO WE MAKE THIS MORE OBVIOUS (4) class MarketingCampaign { /** * Adds email address, person will then be * messaged as part of the campaign. */ public function addEmailAddress( EmailAddress $emailAddress): void { .. some implementation .. } }
- 76. @daveliddament QUESTIONS TO ASK IN CODE REVIEW ARE WE FOLLOWING PROJECT CONVENTIONS?
- 77. @daveliddament ARE WE FOLLOWING PROJECT CONVENTIONS interface LocationRepository { public function findClosestTo($point); public function findByName($name); public function findBySlug($slug); public function searchForLocation($name, $type); public function findAllByType($type); }
- 78. @daveliddament ARE WE FOLLOWING PROJECT CONVENTIONS INCONSISTENT METHOD NAME interface LocationRepository { public function findClosestTo($point); public function findByName($name); public function findBySlug($slug); public function searchForLocation($name, $type); public function findAllByType($type); }
- 79. @daveliddament
- 80. @daveliddament QUESTIONS TO ASK IN CODE REVIEW DO THE COMMENTS MATCH THE CODE?
- 81. @daveliddament QUESTIONS TO ASK IN CODE REVIEW HAS DEFENSIVE CODING BEEN USED?
- 82. @daveliddament HAS DEFENSIVE CODING BEEN USED /** * Set status (one of started|finished|quit) * * @param string $status */ public function setStatus(string $status): void { $this->status = $status; } /** * Set status (one of started|finished|quit) * * @param string $status */ public function setStatus(string $status): void { $this->status = $status; }
- 83. @daveliddament HAS DEFENSIVE CODING BEEN USED MISSING CHECK THAT STATUS IS A VALID VALUE /** * Set status (one of started|finished|quit) * * @param string $status */ public function setStatus(string $status): void { $this->status = $status; } /** * Set status (one of started|finished|quit) * * @param string $status */ public function setStatus(string $status): void { $this->status = $status; }
- 84. @daveliddament QUESTIONS TO ASK IN CODE REVIEW CORRECT NAMING
- 85. @daveliddament QUESTIONS TO ASK IN CODE REVIEW CORRECT NAMING ▸ Language for domain or project you’re working on
- 86. @daveliddament QUESTIONS TO ASK IN CODE REVIEW CORRECT NAMING ▸ Language for domain or project you’re working on ▸ Design patterns
- 87. @daveliddament QUESTIONS TO ASK IN CODE REVIEW HAS TECHNICAL DEBT BEEN DOCUMENTED?
- 88. @daveliddament HAS TECHNICAL DEBT BEEN DOCUMENTED ALL TODO COMMENTS MUST REFERENCE A TICKET // TODO: Refactor to method https://trello.com/c/Aaa123 … some hacky code …
- 89. @daveliddament QUESTIONS TO ASK IN CODE REVIEW CAN ARCHITECTURE BE IMPROVED?
- 90. @daveliddament QUESTIONS TO ASK IN CODE REVIEW ARE THERE ANY BUGS?!
- 91. @daveliddament QUESTIONS TO ASK IN CODE REVIEW CHECK LIST ▸ Do the tests fully test the required functionality ▸ Will I understand this code in 6 months ▸ Does the code follow project conventions ▸ Is the code obvious and explicit ▸ Do comments match the code ▸ Has defensive coding been used ▸ Has technical debt been documented ▸ Can architecture be improved ▸ Are there any bugs
- 92. @daveliddament QUESTIONS TO ASK IN CODE REVIEW CHECK LIST: TLDR ▸ Correct tests ▸ Clean code ▸ No bugs
- 94. @daveliddament CODE REVIEW TIPS EVERYONE SHOULD CODE REVIEW
- 95. @daveliddament ASK PROGRAMMERS TO REVIEW 10 LINES OF CODE THEY’LL FIND 10 ISSUES… Anyone who’s done code review CODE REVIEW TIPS
- 96. @daveliddament ASK THEM TO DO 500 LINES THEY’LL SAY IT’S GOOD TO GO Anyone who’s done code review CODE REVIEW TIPS
- 97. @daveliddament CODE REVIEW TIPS SMALL COMMITS
- 98. @daveliddament CODE REVIEW TIPS SMALL COMMITS
- 99. @daveliddament CODE REVIEW TIPS SMALL COMMITS DEPRECATE: The price calculation service
- 100. @daveliddament CODE REVIEW TIPS SMALL COMMITS DEPRECATE: The price calculation service ADD: Facade to 3rd party price calculation service
- 101. @daveliddament CODE REVIEW TIPS SMALL COMMITS DEPRECATE: The price calculation service ADD: Facade to 3rd party price calculation service UPDATE: Use new price calculator code
- 102. @daveliddament CODE REVIEW TIPS SMALL COMMITS DEPRECATE: The price calculation service ADD: Facade to 3rd party price calculation service UPDATE: Use new price calculator code REMOVE: Deprecated price calculation service
- 103. @daveliddament CODE REVIEW TIPS HOW MUCH SHOULD YOU REVIEW IN ONE GO? ▸ Fewer than 400 lines of code at a time [6] ▸ Under 500 line of code reviewed per hour [6] ▸ Max 1 hour review at a time [6]
- 104. @daveliddament CODE REVIEW TIPS GOOD COMMITS
- 105. @daveliddament CODE REVIEW TIPS GOOD COMMITS ▸ Small
- 106. @daveliddament CODE REVIEW TIPS GOOD COMMITS ▸ Small ▸ Focus on one thing
- 107. @daveliddament CODE REVIEW TIPS GOOD COMMITS ▸ Small ▸ Focus on one thing ▸ Whitespace changes into their own commits
- 108. @daveliddament CODE REVIEW TIPS GOOD COMMITS ▸ Small ▸ Focus on one thing ▸ Whitespace changes into their own commits ▸ Reference to story, bug report, Trello/Jira card
- 109. @daveliddament CODE REVIEW TIPS GOOD REVIEW COMMENTS
- 110. @daveliddament CODE REVIEW TIPS GOOD REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude
- 111. @daveliddament CODE REVIEW TIPS GOOD REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude ▸ Not critical of the author
- 112. @daveliddament CODE REVIEW TIPS GOOD REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude ▸ Not critical of the author ▸ State problem and solution
- 113. @daveliddament CODE REVIEW TIPS GOOD REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude ▸ Not critical of the author ▸ State problem and solution ▸ Link to Stack Overflow, blog, etc
- 114. @daveliddament CODE REVIEW TIPS GOOD REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude ▸ Not critical of the author ▸ State problem and solution ▸ Link to Stack Overflow, blog, etc ▸ Use: “Let’s chat”
- 115. @daveliddament CODE REVIEW TIPS GOOD REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude ▸ Not critical of the author ▸ State problem and solution ▸ Link to Stack Overflow, blog, etc ▸ Use: “Let’s chat” ▸ Use: “Question”
- 116. @daveliddament CODE REVIEW TIPS GOOD REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude ▸ Not critical of the author ▸ State problem and solution ▸ Link to Stack Overflow, blog, etc ▸ Use: “Let’s chat” ▸ Use: “Question” ▸ Compliment
- 117. @daveliddament CODE REVIEW TIPS RECEIVING REVIEW COMMENTS
- 118. @daveliddament CODE REVIEW TIPS RECEIVING REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude
- 119. @daveliddament CODE REVIEW TIPS RECEIVING REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude ▸ Don’t take offence
- 120. @daveliddament CODE REVIEW TIPS RECEIVING REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude ▸ Don’t take offence ▸ Do say if you disagree
- 121. @daveliddament CODE REVIEW TIPS RECEIVING REVIEW COMMENTS ▸ Don’t be an idiot. Don’t be rude ▸ Don’t take offence ▸ Do say if you disagree ▸ Compliment
- 122. @daveliddament CODE REVIEW TIPS CODE REVIEW TIPS ▸ Get everyone involved ▸ Keep commits small ▸ Be constructive in code review comments ▸ Link to relevant bugs / stories / Trello cards
- 123. @daveliddament SETUP GITHUB CODE CAN ONLY BE DEPLOYED IF: ▸ CI passes ▸ Code review passes
- 136. @daveliddament EFFECTIVE CODE REVIEW INTEGRATING CODE REVIEW INTO PROJECT WORKFLOW ▸ Easy with tools like Github ▸ No excuse not to start using today
- 137. @daveliddament EFFECTIVE CODE REVIEW WHAT WE’VE COVERED ▸ Why ▸ Code quality ▸ What is code review ▸ Benefits ▸ Implementation ▸ Tips ▸ Integrating code review into project workflow
- 138. @daveliddament WRAP UP Cost DESIGN WRITING CODE TEST RELEASE MAINTENANCE FIND BUGS SOONER
- 139. @daveliddament WRAP UP WHAT ARE DEFECTS? Bugs Evolvability [1, 2]
- 140. @daveliddament WRAP UP SPREAD THE KNOWLEDGE
- 142. @daveliddament WRAP UP YOU’RE BEING WATCHED!
- 143. @daveliddament WRAP UP YOU’RE BEING WATCHED! [5]
- 145. @daveliddament WRAP UP SUMMARY: REVIEW CHECKLIST ▸ Security problems ▸ Correct tests ▸ Clean code ▸ Bugs
- 146. @daveliddament
- 147. @daveliddament WRAP UP EVERYONE SHOULD CODE REVIEW
- 148. @daveliddament EFFECTIVE CODE REVIEW REDUCES OVERALL COST OF SOFTWARE DEVELOPMENT
- 150. @daveliddament REFERENCES REFERENCES ▸ [1] Mika V. Mantyla and Casper Lassenius “What Types of Defects Are Really Discovered in Code Reviews?” IEEE Transactions on Software Engineering ▸ [2] Harvey Siy, Lawrence Votta “Does The Modern Code Inspection Have Value?” ▸ [3] R.K. Bandi, V.K. Vaishnavi, and D.E. Turk, “Predicting Maintenance Performance Using Object-Orientated Design Complexity Metrics” ▸ [4] R.D. Banker, S.M. Datar, C.F. Kemerer, and D. Zweig, “Software Complexity and Maintenance Costs,” ▸ [5] https://www.bbc.co.uk/news/uk-37502136 ▸ [6] https://smartbear.com/learn/code-review/best-practices-for-peer-code- review/
- 151. @daveliddament CREDITS IMAGE CREDITS ‣ © Can Stock Photo / kmitu ‣ © Kirsty Andrews ‣ © Jez Kent ‣ © Can Stock Photo / focalpoint ‣ © Can Stock Photo / sellingpix ‣ © Can Stock Photo / robwilson39 ‣ © Can Stock Photo / lindwa ‣ © Can Stock Photo / piedmont_photo ‣ © Can Stock Photo / pressmaster ‣ © Can Stock Photo / marish