Revues de code pour devenir un meilleur développeur
D'après mon expérience, participer à une revue de code est le moyen le plus efficace de progresser en tant que développeur. Si vous êtes l'auteur des modifications examinées, vous pouvez obtenir des commentaires directs de vos collègues. Et si vous êtes l'un des examinateurs, vous pouvez apprendre différentes approches auxquelles vous n'auriez peut-être pas pensé pour résoudre les implémentations.
Mais donner et comprendre correctement une revue de code est une compétence qui doit être apprise. Dans cet article, je vais simplement énumérer certains aspects que je prends en compte lorsque je donne et reçois des révisions de code. De mon point de vue, ils se sont avérés être le bon choix pour un environnement de développement collaboratif et accueillant.
Ce que je définis comme un bon code
N'oubliez pas qu'il n'y a rien de plus permanent qu'une solution de contournement temporaire.
Les mesures clés suivantes me guident lors de l'écriture et de la révision du code.
- le code est maintenable, par ex. pas de piratage ni de solution de contournement, mais bien documenté
- le code est facilement lisible, donc le raisonnement est beaucoup plus facile
- le code est testable, améliorant ainsi encore les deux points précédents
Comment faire une revue de code
Être humble
Se tromper n'est pas un problème. Insister sur le fait que vous avez raison même si vous ne l'êtes objectivement pas est un problème. Gardez toujours à l'esprit que vous pourriez manquer quelque chose ou simplement mal comprendre le code. Soyez ouvert aux réactions négatives et soyez humble pour avoir la chance d'apprendre quelque chose de nouveau.
Les revues de code ne sont pas personnelles
N'oubliez pas : le code vient en premier. Vous pouvez revoir le code de quelqu'un dans une situation tendue où vous n'êtes pas d'humeur à vous parler ou êtes généralement en désaccord sur la façon dont les choses fonctionnent actuellement.
Les revues de code ne sont pas le lieu pour se défouler ou pour rembourser les frustrations. Le seul but des revues est d'améliorer objectivement la qualité du code. Le code que vous révisez et qui sera fusionné est le prochain code hérité, il est donc important de laisser de côté les choses personnelles et de fournir un examen objectif, peu importe qui est l'évalué.
Les avis ne sont pas des avis
Une différence clé entre une bonne critique et un simple commentaire est que les critiques laissent de côté les opinions. Par exemple, peu importe à quoi ressemble le style de code, tant qu'il est maintenable, facilement lisible et testable. Si vous n'êtes pas sûr que votre avis serait opiniâtre, ajoutez simplement une remarque afin que vous puissiez discuter du point avec votre collègue.
De bonnes critiques mènent à de bonnes discussions
Contester une révision peut conduire à d'importants transferts de connaissances entre les développeurs. Un avis donné ne doit pas être traité comme un commentaire final, mais plutôt comme un point de départ pour des discussions afin d'obtenir une vue d'ensemble. Vous pourriez tous les deux manquer quelque chose et discuter de la critique ne peut qu'améliorer votre compréhension.
Les délais n'ont pas d'importance
Pas toujours facile à appliquer, mais ignorer les révisions de code peut potentiellement créer une dette technique importante que personne ne voudra nettoyer. Il est important de maintenir la discipline nécessaire pour effectuer des révisions approfondies du code, même si vous entendez le compte à rebours. Vous pourriez être le prochain développeur à travailler sur ce gâchis !
Utilisez des liens pour les références
La comparaison du code révisé avec celui existant se produit assez souvent. Il est donc important d'inclure correctement les références via des liens. Ne mentionner que l'endroit approximatif où se trouve le code référencé ne suffit pas.
Utilisez la fonctionnalité de votre contrôle de code source pour mettre en évidence le code sur une branche existante et utilisez les URL créées dans votre révision à titre de référence. Il en va de même pour la documentation externe, par exemple sur MDN.
Comment lire une revue de code
Tout ce qui précède
La lecture des revues de code de votre code fait de vous un meilleur développeur lorsque vous suivez tous les points susmentionnés. Soyez humble, ne prenez pas les critiques personnellement et efforcez-vous de comprendre ce qu'un avis indique pour mieux comprendre la situation dans son ensemble.
Une opinion personnelle sur la façon d'être objectif
Cet article reflète mon approche personnelle sur les revues de code. Les points exposés ne sont que l'aboutissement de mon expérience en tant que développeur dans des équipes grandes et petites, à la fois locales et internationales. Ils ont fait leurs preuves, menant à un meilleur code et me donnant l'opportunité d'apprendre directement des autres.
