Code review for busy people
0 likes175 views
This document discusses tips for conducting quick and useful code reviews. It recommends including code reviews in your daily coding routine by dedicating short periods of time, such as 15 minutes, to focused code reviews. The document provides suggestions for what to review, such as choosing common bugs or static analysis rules to search for issues. It emphasizes fixing easy bugs first and using code reviews as an opportunity to learn new techniques and document local coding idioms.
![WHERE IS THE BUG?
<?php
$versions = ['72' => 'Woody', '7.1' => 'Kalla',];
foreach($versions as $short => $full) {
print $short[0].PHP_EOL;
}
?>
7](https://image.slidesharecdn.com/codereviewforbusypeople-180606123919/85/Code-review-for-busy-people-16-320.jpg)
![ANYTHING BETTER?
<?php
foreach($results as $result) {
$cols[] = $result->a;
}
?>
$cols[] = $result['a'];
<?php
$cols = array_column($result, 'a');
?>](https://image.slidesharecdn.com/codereviewforbusypeople-180606123919/85/Code-review-for-busy-people-19-320.jpg)
Code review for busy people
- 1. PHP REVIEWS FOR BUSY PEOPLE IPC, Berlin, Germany 2018
- 2. AGENDA Include code reviews in your coding day Tips and tricks to do them usefully and quickly We have no time, let's go to the next slide!
- 3. SPEAKER Damien Seguy CTO Exakat Static analysis engine for PHP Altersheim für Elephpant Ich spreche kein Deutsch
- 4. CODE REVIEW AS RELAXATION when the pause is the code review
- 5. BOXED TIME REVIEW 15 mins away from meeting, early at work, about to leave… avoid a real task by looking usefully busy Any random time that is free : 10 to 20 mins Time Box and distraction free Small and focused fix in the code
- 6. WHAT TO REVIEW? Garçon, le menu!
- 9. STATIC ANALYSIS Code analysis without execution PHP has a growing list of tools https://github.com/exakat/php-static-analysis- tools/ 90 tools in the list
- 10. STATIC ANALYSIS PHP 5 / 7 Calisthenics ClearPHP Performance
- 11. RELAX AND REVIEW New feature Meeting Audit run Audit run Audit runs Developer time Code review
- 12. ON THE HOOK New feature Next feature Ho ok Developer time Co de rev iew Co m mit ru nCode review PHP Inspector Phan, Psalm, PHPStan
- 13. ON THE HOOK Great for local bugs Avoid committing errors or violations May be sidelined by emergency
- 14. FAST CHECK
- 15. SLOW REVIEW New feature Meeting Audit run Audit run Developer time Code review
- 16. WHERE IS THE BUG? <?php $versions = ['72' => 'Woody', '7.1' => 'Kalla',]; foreach($versions as $short => $full) { print $short[0].PHP_EOL; } ?> 7
- 17. DON'T TALK ABOUT BUG <?php if (strpos($string, ':') == false) { print ": foundn"; } else { print ": not foundn"; } ?>
- 18. FIX EARLY BUGS Classic bugs Easy to understand Easy to forget Short list If not so short, make it shorter
- 20. TARGET Fix bug early Clean the code Learn new technique Reference local idioms Document code
- 21. WHAT AN HORRIBLE PATOIS first you marry, then you statoil!
- 22. LOCAL IDIOMS The way the code is done here
- 23. The way the code is done here
- 24. FACING THE HORDE what if they all came?
- 25. FIX EARLY BUGS Use ++$i, not $i++ Usage of @ Switch without default printf('%s', $a, $b); $c = $a + $b - $a +$d
- 26. FIX EARLY BUGS Use ++$i, not $i++ Usage of @ Switch without default printf('%s', $a, $b); $c = $a + $b - $a +$d Easy Medium Harder Easy Easy
- 27. FIX EARLY BUGS Use ++$i, not $i++ Usage of @ Switch without default printf('%s', $a, $b); $c = $a + $b - $a +$d Easy Medium Harder Easy Easy 90% 53% 51% 27% 3% https://www.exakat.io/exakat-coding-index-2018-05/
- 28. 100 1 2 3 4 5 6 7 8 9 10 0 1 2 3 4 5 6 7 8 9 Difficulty Frequency ++$i Switch without default @ $a - $a Printf()
- 29. 100 1 2 3 4 5 6 7 8 9 10 0 1 2 3 4 5 6 7 8 9 Difficulty Frequency ++$i Switch without default @ $a - $a Printf()
- 30. 100 1 2 3 4 5 6 7 8 9 10 0 1 2 3 4 5 6 7 8 9 Difficulty Frequency ++$i Switch without default @ $a - $a Printf()
- 31. WE WALK ON TWO LEGS Discovery Hunt bugs
- 32. DISCOVERY Undefined variables Variables used once Variables written only Variables used twice : one write, one read Is order important ?
- 34. STARTING RIGHT first month : 10 rules Next month : 10 other rules and discovery 1 month 2 month 3 month Rules
- 35. CODE REVIEW AS RELAXATION when the pause is the code review
- 36. CODE REVIEW TIPS Automate issues search Select the important rules for you Do the easy fix first Always keep an eye open for the next bug 4 hours a week is a good target, in small bits
- 37. LINKS EPIC : https://www.exakat.io/exakat-coding- index-2018-05/ Exakat : https://www.exakat.io/ Phan : https://github.com/phan/phan PHP Inspection : https://plugins.jetbrains.com/plugin/ 7622-php-inspections-ea-extended- PHPStan : https://github.com/phpstan/phpstan
- 40. The way the code is done here
- 41. EASY TO FIX FIRST Spot easy to fix first Fix them without discussion Or set them out of scope : Not Fixed Here
- 42. EASY TO FIX FIRST Easy to fix Frequent in the code Critical to the organization
- 43. Quick checks Slower checks Conception level
- 44. LEVEL OF FIXING Quick checks Slower checks Conception level Screen size fix Local Variable Variable/ properties Whole class
- 45. ELEVATING TRAINING Move from code to team In IDE => in repository => documented
- 46. EXTRACTING IDIOMS Move from code to team In IDE => in repository => documented
- 47. AUTOMATED DOCUMENTATION Extract information important for all Read it or transmit it to others Some of it can be automated
- 48. Team work Team work Team work Team work
- 49. CODE AS RELAXATION 15 mins are easy to find You could have brought it here now :)
- 50. AUTOMATE WHAT IS POSSIBLE PHP version pre-requisite PHP bugs