about_reviewing_code

Une review Pourquoi ?

Une review de code sert à plusieurs choses :

• partager les choses que l'on fait dans le code (les reviewers sont informés des nouveautés)
• partager le savoir (les reviewers peuvent échanger avec la personne ayant proposé la PR au sujet des pratiques, des pratiques à utiliser, des astuces sur les librairies utilisées ou le python en lui même)
• partager et faire évoluer les règles standards que l'équipe doit suivre dans le développement
• proposer des améliorations
• détecter avant la mise en prod des bugs.

Une review Comment ?

Une review de code doit être bienveillante. C'est à dire qu'il est donc interdit aux reviewers :

• d'utiliser de l'impératif
• d'utiliser des qualificatif de nom d'oiseaux, des noms de substances odoriférantes ou des mots péjoratifs pour qualifier le code qui est lu
• de péremptoirement imposer une modification dans le code sans explication, argumentation, discussion
• d’émettre des jugements de valeur aussi personnel que non étayé