Successfully reported this slideshow.

Code Review: How and When

3

Share

Upcoming SlideShare
How and When To Code Review
How and When To Code Review
Loading in …3
×
1 of 77
1 of 77

Code Review: How and When

3

Share

Download to read offline

You want to improve your software skills. That’s a given. You may be a mentor or a manager who needs to improve the knowledge sharing among your software developers across different projects. Code Reviews can do just that while improving code quality in your projects. Code Review not only builds developer team spirit but also offers new ways to improve a software solution. You’ll walk away from this session with in-depth understanding of Code Review to strengthen your team.

You want to improve your software skills. That’s a given. You may be a mentor or a manager who needs to improve the knowledge sharing among your software developers across different projects. Code Reviews can do just that while improving code quality in your projects. Code Review not only builds developer team spirit but also offers new ways to improve a software solution. You’ll walk away from this session with in-depth understanding of Code Review to strengthen your team.

More Related Content

Related Books

Free with a 14 day trial from Scribd

See all

Code Review: How and When

  1. 1. Code Review How And When @paulmgower
  2. 2. DevSpace would like to thank our sponsors!
  3. 3. I’m Paul Gower. Principal Consultant at Lunamark @paulmgower
  4. 4. AGENDA What Is Code Review1 2 3 How and When Why Code Review
  5. 5. What Is Code Review 1
  6. 6. Father of Code Review http://ieeexplore.ieee.org/xpl/articleDetails.jsp?arnumber=5388086&filter%3DAND%28p_IS_Number%3A5388084%29 aka Fagan Inspections
  7. 7. Fagan Inspections https://en.wikipedia.org/wiki/Fagan_inspection
  8. 8. Code Review History
  9. 9. Why Use Fagan Inspections?
  10. 10. Why Use Fagan Inspections? Good for Mission Critical Software
  11. 11. Lightweight Code Reviews https://en.wikipedia.org/wiki/Code_review
  12. 12. Over-the-shoulder
  13. 13. Email pass-around
  14. 14. Email pass-around Please don’t do this!
  15. 15. Pair Programming
  16. 16. Code Review Tools
  17. 17. Code Review Tool Resources • github reviews - https://github.com/universe-2016#reviews • video demo - https://www.youtube.com/watch?v=HW0RPaJqm4g • reviewable - https://reviewable.io/ • demo - https://reviewable.io/reviews/Reviewable/demo/1 • gerrit code review - https://www.gerritcodereview.com • tutorial - http://www.vogella.com/tutorials/Gerrit/article.html • VSTS Code Review (TFVC) - https://www.visualstudio.com/en-us/docs/ tfvc/get-code-reviewed-vs • walk through - https://www.visualstudio.com/en-us/docs/tfvc/day-life- alm-developer-suspend-work-fix-bug-conduct-code-review
  18. 18. • Review Assistant - https://www.devart.com/review-assistant/ • comparison - https://www.devart.com/review-assistant/learnmore/ visual-studio-vs-review-assistant.html • Crucible - https://www.atlassian.com/software/crucible • video demo - https://www.youtube.com/watch?v=UFNPgfQFJHk • Collaborator - https://smartbear.com/product/collaborator/overview/ • video demo - https://www.youtube.com/watch?v=1MBb21DgRYg • FogBugz Dev Hub - http://www.fogcreek.com/fogbugz/devhub • demo - http://www.joelonsoftware.com/items/2011/02/03.html Code Review Tool Resources
  19. 19. How and When 2
  20. 20. Reviewer: Focus on the code
  21. 21. Reviewer: Focus on the code Don’t say: “You didn’t name these variables well!”
  22. 22. 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?”
  23. 23. Reviewer: Be respectful
  24. 24. Reviewer: Find a positive point
  25. 25. How NOT to Code Review
  26. 26. Author: Be humble
  27. 27. Author: Prepare Before
  28. 28. “ “The objective is for everyone to find defects, including the author, not to prove the work product has no defects. People exchange work products to review, with the expectation that as authors, they will produce errors, and as reviewers, they will find errors. Everyone ends up learning from their own mistakes and other people’s mistakes.” – Jerry Weinberg, “The Psychology of Computer Programming”, 1971
  29. 29. Tips and Tricks
  30. 30. Less Than 200 Lines Of Code
  31. 31. Less Than 60 Minutes
  32. 32. Less Than 60 Minutes http://www.news.illinois.edu/news/11/0208focus_AlejandroLleras.html
  33. 33. Daily Code Review
  34. 34. Daily Code Review http://blog.fogcreek.com/effective-code-reviews-9-tips-from-a-converted-skeptic/
  35. 35. Always Use A Checklist http://www.codeproject.com/Articles/593751/Code-Review-Checklist-and-Guidelines-for-Csharp-De
  36. 36. Developer Checklist • Does my code compile without errors and run without exceptions in “happy path” conditions? • Have I checked this code to see if it triggers compiler or static analysis warnings? • Have I covered this code with appropriate tests, and are those test currently green? • Have I run our performance/load/smoke tests to make sure nothing I’ve introduced is a performance killer? http://blog.smartbear.com/code-review/creating-your-code-review-checklist/
  37. 37. Reviewer Checklist • Does this code read like prose? • Do the methods do what the name of the method claims that they’ll do? Same for classes? • Can I get an understanding of the desired behavior just by doing quick scans through unit and acceptance tests? • Is anything here a re-implementation of existing functionality the developer may not be aware of? http://blog.smartbear.com/code-review/creating-your-code-review-checklist/
  38. 38. Don’t Be This Guy
  39. 39. Don’t Review What Can Be Automated
  40. 40. Static Code Analysis Tools
  41. 41. https://www.npmjs.com/package/eslint-watch
  42. 42. Static Code Analysis Resources • JSLint - http://www.jslint.com • video demo - https://www.youtube.com/watch?v=QWjMZBoSBtQ • JSHint - http://jshint.com • video demo - https://www.youtube.com/watch?v=MvV6fljX538 • ESLint - http://eslint.org • video demo - https://www.youtube.com/watch?v=L6vMey4FtQ0 • StyleCop - https://stylecop.codeplex.com • video demo - https://www.youtube.com/watch?v=6v8_PdePM7M • Visual Studio Code Analysis - https://msdn.microsoft.com/en-us/library/ 3z0aeatx.aspx • walkthrough - https://msdn.microsoft.com/en-us/library/ms182066.aspx • ReSharper - https://www.jetbrains.com/resharper/ • demo - https://www.youtube.com/watch?v=jq1JDlIiRmg
  43. 43. 3 Why Code Review
  44. 44. “ “…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
  45. 45. Before 55% Code Review Case Studies
  46. 46. Before After 2% 55% Code Review Case Studies
  47. 47. Before Code Reviews
  48. 48. After Code Reviews
  49. 49. Reasons to Code Review
  50. 50. Save Money
  51. 51. Easier To Find Other’s Mistakes
  52. 52. Alternative Implementations
  53. 53. Knowledge Sharing
  54. 54. “ “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
  55. 55. 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
  56. 56. THANK YOU! @paulmgower http://bit.ly/ds2016-cr lunamark.com

×