DevoxxFR 2016: How to stop wasting your time and start performing useful code reviews

Transcript

1. #DevoxxFR How to stop wasting your time and start performing useful code reviews Maria Khalusova, JetBrains @mariakhalusova 1
2. #DevoxxFR Roadmap 2 Code review benefits Where to begin? How to make code reviews efficient? What to look for? Code review feedback @mariakhalusova
3. #DevoxxFR Why review code at all? 3 @mariakhalusova
4. #DevoxxFR Code review benefits 4 Finding bugs Knowledge sharing Faster on-boarding Better team collaboration Easier code maintenance Increased “Bus Factor” Improved code quality @mariakhalusova
5. #DevoxxFR Where to begin? 5 @mariakhalusova
6. #DevoxxFR 4 keys to a successful start 6 @mariakhalusova Team Change impact Process New tool
7. #DevoxxFR Team 7 Set the goals and communicate them clearly Listen to concerns Cultivate code review culture @mariakhalusova
8. #DevoxxFR Change impact 8 @mariakhalusova Who? What? When?
9. #DevoxxFR Process 9 Where does it fit? Keep your workflow simple Don’t be scared of iterations Average of 2 reviewers Review often @mariakhalusova
10. #DevoxxFR New tool 10 The right code review tool: • Fits in your environment • Supports your workflow • Doesn’t stand in your way @mariakhalusova
11. #DevoxxFR Summary 11 • Talk to your team • Consider the process and overall change impact • Find the right tool @mariakhalusova
12. #DevoxxFR How to make the most out of code reviews? 12 @mariakhalusova
13. #DevoxxFR Automate what you can 13 Tests Continuous Integration Static Code Analysis Spellchecker etc. @mariakhalusova
14. #DevoxxFR 14 @mariakhalusova Code review is not a place for coding style wars
15. #DevoxxFR As code author 15 Review your own code Commit small changes Document your code Provide meaningful commit message @mariakhalusova
16. #DevoxxFR As reviewer 16 Don’t postpone it Don’t spend too much time on a review Keep in mind project’s priorities Apply your expertise @mariakhalusova
17. #DevoxxFR What to look for in a code review? 17 @mariakhalusova
18. #DevoxxFR General and business logic 18 Correctness Coding errors Business rules and logic User-facing messages @mariakhalusova
19. #DevoxxFR Architecture and design 19 Is the code in the right place? Reusability Data structures SOLID YAGNI (You Aren't Gonna Need It) @mariakhalusova
20. #DevoxxFR Readability & Maintainability 20 Naming Readability Documentation Test coverage @mariakhalusova Always code as if the person who ends up maintaining your code is a violent psychopath who knows where you live. - John F. Woods (1991)
21. #DevoxxFR Performance 21 @mariakhalusova Performance requirements Performance tests Common causes of performance problems, e.g.: • Unnecessary networks calls • Potential memory leaks • Not closed connections/streams • Too many calls to the database
22. #DevoxxFR Security 22 @mariakhalusova Third-party libraries Authentication Data encryption Proper management of passwords/encryption keys, etc. Potential issues
23. #DevoxxFR How to have code review discussions without starting a war in the comments? 23 @mariakhalusova
24. #DevoxxFR Human factor 24 @mariakhalusova
25. #DevoxxFR Human factor 25 @mariakhalusova
26. #DevoxxFR Giving feedback: reasons 26 @mariakhalusova • There’s a problem • To help someone improve • To start a discussion • To praise good work • Because of the pressure to find a problem • To boost own ego
27. #DevoxxFR Code review feedback manners 27 @mariakhalusova • Leave feedback if your goal is improvement • Appropriate timing and place • Indicate when you’re done with a review • Discuss changes, not people • Carefully consider wording
28. #DevoxxFR Giving feedback: wording 28 @mariakhalusova Don’t be rude.
 “WTF is this?” Assume the code author is intelligent and qualified
 “This will not work if…” vs “What happens if..?” Avoid using “obviously”, “simply” Avoid possessive adjectives
 “Your method returns…” vs “This method returns…”
29. #DevoxxFR Giving code review feedback 29 @mariakhalusova Be specific Don’t demand, ask questions Don’t use sarcasm Suggest alternatives
30. #DevoxxFR Receiving feedback 30 @mariakhalusova Acknowledge that feedback helps you improve Invite teammates to review your code Separate criticism from self Immediate reaction isn’t always the best one Ask questions Be grateful for the feedback
31. #DevoxxFR Thank you 31 @mariakhalusova