Publié le 20 juillet 2017
  • Débutant
  • Bonnes pratiques
  • Développement

4 trucs et astuces pour une revue de code bienveillante

Intéressant cet article ?

[Total : 0    Moyenne : 0/5]

La revue de code peut s’avérer pénible. Cet exercice consiste à relire le code d’un logiciel ou d’un site web pour corriger d’éventuelles erreurs avant la mise en production et ainsi améliorer la qualité du code final.

Cette démarche peut parfois être automatisée mais le plus souvent, c’est un humain qui s’y colle ! Si elle peut sembler rébarbative, il y a bien une plus-value à ce que cette tâche soit effectuée par un individu en chair et en os… Un petit quelque chose qui nous différencie de la machine… La bienveillance !

Réduisez le volume de lignes à vérifier

Lorsque vous demander à l’un•e de vos collègues de vous relire, mettez-vous à sa place et transmettez-lui de petites portions de votre code plutôt qu’un gros bloc, quitte à le faire en plusieurs fois. Vous l’avez peut-être déjà constaté mais plus il y a de matière moins nous sommes prompts à commenter. Il reste toujours une coquille dans un roman alors qu’elles sautent aux yeux dans un slogan (enfin normalement) !

exemple-importance-relecture

L’exception qui confirme la règle, merci Bescherelle Ta Mère !

Chassez l’ego de vos revues de code

Soumettre son travail à ses pairs n’est pas toujours très confortable, surtout si vos collègues ne sont pas les rois de la diplomatie ! Si ce constat renforce la nécessité d’une revue de code bienveillante, il révèle également que nous avons tendance à confondre notre travail et nous-mêmes.

La première astuce pour rendre la revue de code plus facile pour tous est donc d’arrêter avec le « Codito, ergo sum » : vous n’êtes pas votre code ! Partant de là, vous serez plus détendu•e vis-à-vis des retours et pourrez les accueillir de façon constructive. D’ailleurs, le fait même de faire relire et valider votre travail revient à partager la responsabilité de ce code et donc à en faire une œuvre collective !

Ah oui, et puis, rappelez-vous, l’erreur est humaine, tout ça, tout ça 

Ne vous braquez pas sur la forme

La revue de code est un exercice complexe. Chacun•e, en fonction de son parcours, de ses compétences spécifiques, de ses appétences, prête attention à des choses différentes, c’est ce qui fait la richesse de la revue. D’ailleurs, vous confrontez à d’autres visions que la vôtre est un excellent moyen de continuer à apprendre quel que soit votre niveau d’expérience. C’est pourquoi ne passez pas trop de temps à vous offusquer sur la forme (indentation, sauts de lignes, etc.) des outils le font très bien pour vous. Votre valeur ajoutée est ailleurs ! Dans les commentaires constructifs que vous pouvez faire sur le fond par exemple :)

Commentez le code… Et rien que le code !

Toutefois, pour que l’exercice profite aux deux parties ainsi qu’au projet, les retours doivent concerner le code et pas la•le développeur•euse qui l’a produit. En dirigeant vos commentaires, même constructifs, sur la personne et non sur son travail, vous créez les conditions pour qu’elle remette de l’ego dans son code… Eh oui, vous la jugez à travers lui ! Il s’agit là essentiellement d’une affaire de formulation, un « Je n’aurais pas fait comme ça » plutôt qu’un « Tu as choisi la mauvaise solution », qui peut s’apparenter aux principes de la Communication Non-Violente. D’ailleurs, en cas de doute privilégiez toujours un bon vieux face-à-face, cela évite bien des malentendus

Et vous, quelles sont vos bonnes pratiques en matière de revue de code ?

Sylvain P.

Cet article est une synthèse/adaptation de l’excellent billet de Gilles Roustan à lire ici !

La-qualité-une-responsabilité-collective
Qu'est-ce-qu-un-CDN_blog-JETPULP
ShadowIT
ShadowIT
security-265130_960_720
ShadowIT
0 Commentaires
Répondre
Se joindre à la discussion ?
Vous êtes libre de contribuer !
Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *