Faire de la revue de code comme un "pro" - Cabane Québec 2019

La revue de code est un super outil pour attraper des erreurs, disséminer les idées et le savoir, et alimenter la collaboration entre les membres de votre équipe. Voyons ensemble le pourquoi et le comment de la revue de code, autant du côté dévelopeur que du côté business. Comment faire une requête de changement facile à réviser, quoi automatiser, à quels détails être le plus attentif et quels sont les gains pour votre entreprise.

Transcript

1. View Slide

2. Mais... à quoi ça sert ?
   

   View Slide

3. Réduit les coûts
   

   View Slide

4. Stimule la collaboration
   ✦ permet de briser les silos
   ✦ favorise l'ownership du projet
   ✦ "coaching" de devs plus juniors
   

   View Slide

5. Améliore la communication
   ✦ diffusion de pratiques émergentes
   ✦ règle de l'autobus
   !
   ✦ conserve les discussions sur le code
   ✦ facilite le travail avec employés "remote"
   

   View Slide

6. Être un réviseur pro
   

   View Slide

7. Donnez du contexte
   

   View Slide

8. View Slide

9. "corriger bug N+1"
   

   View Slide

10. View Slide

11. Donnez des exemples
    

    View Slide

12. "Voici comment récupérer le count"
    

    View Slide

13. Dirigez vers de la documentation
    

    View Slide

14. Suggérez des changements
    

    View Slide

15. View Slide

16. Critiquez le code,
    jamais la personne
    

    View Slide

17. Félicitez les bons coups
    > Good job, c'est génial comme système
    d'alertes !
    

    View Slide

18. Posez des questions
    

    View Slide

19. Répondez aux questions
    

    View Slide

20. Préparez une "checklist"
    de points à valider
    

    View Slide

21. Checklist de réviseur
    

    View Slide

22. Tenez vos revues à < 200-400 loc
    

    View Slide

23. Tenez vos revues à < 60-90 min
    

    View Slide

24. Prenez au moins 5 min
    *même pour 1 seule ligne
    

    View Slide

25. Être un auteur pro
    

    View Slide

26. Ouvrez une PR/MR
    le plus tôt possible
    

    View Slide

27. Limitez la portée de vos changements
    

    View Slide

28. Revue de 5 lignes vs 5000 lignes
    

    View Slide

29. Faites des commits "logiques"
    

    View Slide

30. Racontez une histoire
    * 2eaf071 - revert fix
    * 75edd04 - fix bug
    * 561d6ff - *derp*
    * c803f9e - ajouter fichiers
    

    View Slide

31. Racontez une histoire
    * 2eaf071 - Stocker les pdfs générés dans le bucket 2
    * 75edd04 - Stocker les images dans le bucket 1
    * 561d6ff - Configuration des 2 buckets S3
    * c803f9e - Installation du SDK d'AWS via composer
    

    View Slide

32. N'hésitez pas à donner du contexte
    

    View Slide

33. Gardez votre historique
    propre
    

    View Slide

34. Faites un "auto peer-review"
    

    View Slide

35. !
    Annotez vos changements
    

    View Slide

36. Faites rouler les tests
    

    View Slide

37. !
    Isolez
    les changements esthétiques
    

    View Slide

38. !
    Automatisez
    les changements esthétiques
    

    View Slide

39. Gardez votre branche à jour
    

    View Slide

40. Gardez une "checklist" de vos
    erreurs courantes
    

    View Slide

41. Checklist d'auteur
    

    View Slide

42. Vous n'êtes pas votre code
    

    View Slide

43. Être une équipe pro
    

    View Slide

44. Établissez vos standards
    

    View Slide

45. Linting
    (SCSS/LESS/CSS, JS/ES, Python, etc)
    

    View Slide

46. Formattage automatique
    

    View Slide

47. Créez-vous des templates
    

    View Slide

48. Variez les réviseurs
    

    View Slide

49. Réservez du
    pour la revue de code
    

    View Slide

50. Assigner/choisir ses réviseurs
    

    View Slide

51. Les outils de pros
    

    View Slide

52. Développement collaboratif
    

    View Slide

53. Intégration continue (CI)
    

    View Slide

54. Synchronizez vos outils ensemble
    

    View Slide

55. Configurez le nombre de revues requises
    

    View Slide

56. TextExpander
    

    View Slide

57. Annotate
    

    View Slide

58. Bonne revue de code!
    Merci!
    

    View Slide

59. Questions ?
    

    View Slide