Code Review: Pitfalls and Good Practices

RubyConf AU 2016

Some of us have practiced code review as part of our software development process. But it is more than just a peer review of code written by another. I will attempt to summarise some of the good practices that worked for us to review code effectively and some of the common mistakes not to make when setting out a code review programme for your team.

Transcript

1. CODE REVIEW
   

   View Slide

2. THONG KUAH
   CODE REVIEW
   I have a white cat. His twitter is @awesomemuffin
   My twitter handle is @kuahyeow
   Email ? thong.kuah@powershop.co.nz
   

   View Slide

3. POWERSHOP
   

   View Slide

4. HOW WE FIXED OUR
   CODE REVIEW PROCESS
   

   View Slide

5. View Slide

6. SPRINT 119
   APRIL 2015
   

   View Slide

7. VERY LARGE
   CHANGES
   

   View Slide

8. COMPLEX
   SOLUTIONS
   

   View Slide

9. LARGE DIFFS
   

   View Slide

10. OMG !
    

    View Slide

11. RETROSPECTIVE
    

    View Slide

12. WORKS WELL...
    • CODE REVIEWS ARE NOT OPTIONAL
    • WE HAVE A DEFINITION OF DONE
    • WE TEST OUR CODE
    

    View Slide

13. REVIEW OFTEN
    • EVERYONE PLANS OUT THE WORK
    • WE SEEK FEEDBACK OFTEN
    • FINAL REVIEW
    

    View Slide

14. MAKE CHANGES
    SMALL
    

    View Slide

15. EVERYONE
    REVIEWS
    

    View Slide

16. OMG, BAD
    CODE TO PROD ?
    

    View Slide

17. MORE REVIEWS
    • FINAL REVIEW
    • 2ND BREAKFAST
    • QA TESTING
    • RELEASE REVIEW
    

    View Slide

18. GROW THE TEAM
    • LOTS OF ENCOURAGEMENT
    • OPEN TO FEEDBACK
    • OTHER CODE REVIEWS
    

    View Slide

19. SIX MONTHS
    LATER...
    

    View Slide

20. View Slide