Les revues de code sont importantes car elles améliorent la qualité du code et rendent votre base de code plus stable. En outre, elles aident les programmeurs à établir des relations et à travailler ensemble plus efficacement.
Mais réviser le code d’un pair est plus facile à dire qu’à faire. Sans compter que la gestion d’un processus de révision peut être un cauchemar pour les chefs d’équipe. Pour cette raison, nous expliquons ce qu’il faut rechercher dans une revue de code, le processus de revue de code, et quelles sont les neuf meilleures pratiques de revue de code.
Lisez la suite ou passez directement à la section qui vous intéresse le plus :
- Bonnes pratiques en matière de revue de code
- Bonnes pratiques en matière de revue de code par les pairs
- Bonnes pratiques en matière de revue de code pour savoir comment mener une revue de code
- Appliquer les bonnes pratiques en matière de revue de code avec . les bons outils
- ▶️ Démarrez votre essai gratuit d’analyse de code statique
Bonnes pratiques de revue de code
Voici les neuf bonnes pratiques de revue de code :
1. Savoir ce qu’il faut rechercher dans une revue de code
2. Construire et tester – avant la revue
3. Ne pas revoir le code pendant plus de 60 minutes
4. Ne pas vérifier plus de 400 lignes à la fois
5. Donnez des commentaires qui aident (et non qui nuisent)
6. Communiquez les objectifs et les attentes
7. Incluez tout le monde dans le processus de révision du code
8. Favorisez une culture positive
9. Automatisez pour gagner du temps
Bonnes pratiques de la revue de code par les pairs
Nous allons vous dévoiler les secrets les mieux gardés des revues par les pairs. Les examens par les pairs sont une question de collaboration, et non de concurrence.
Suivez ces cinq meilleures pratiques de revue de code par les pairs.
Savoir ce qu’il faut rechercher dans une revue de code
Il est important d’aller dans les revues en sachant ce qu’il faut rechercher. Recherchez des éléments clés, tels que…
Structure. Le style. La logique. La performance. Couverture des tests. La conception. Lisibilité (et maintenabilité). Fonctionnalité.
Vous pouvez faire des vérifications automatisées (par exemple, l’analyse statique) pour certaines choses – par exemple, la structure et la logique. Mais d’autres – par exemple, la conception et la fonctionnalité – nécessitent un réviseur humain pour les évaluer.
Evaluer le code avec certaines questions en tête peut vous aider à vous concentrer sur les bonnes choses. Par exemple, vous pourriez évaluer le code pour répondre à :
- Comprends-je ce que fait le code ?
- Le code fonctionne-t-il comme je l’attends ?
- Ce code répond-il aux exigences réglementaires ?
En évaluant le code de manière critique – avec des questions en tête – vous vous assurerez de vérifier les bonnes choses. Et vous réduirez le temps consacré aux tests.
Construire et tester – avant la revue de code
À l’heure de l’intégration continue (CI), il est essentiel de construire et de tester avant de procéder à une revue manuelle. Idéalement, une fois les tests réussis, vous effectuerez une révision et la déployerez sur la codeline dev.
Cela permet de garantir la stabilité. Et faire d’abord des vérifications automatisées permet de réduire les erreurs et de gagner du temps dans le processus de révision.
L’automatisation vous évite de perdre du temps dans les revues.
▶️ Commencez votre essai gratuit de l’analyse de code statique >>>
Ne pas réviser le code pendant plus de 60 minutes
Ne jamais réviser pendant plus de 60 minutes à la fois. La performance et l’attention portée aux détails ont tendance à chuter après ce point. Il est préférable d’effectuer des révisions souvent (et en sessions courtes).
Prendre une pause donnera à votre cerveau une chance de se réinitialiser. Ainsi, vous pourrez le réviser à nouveau avec un regard neuf.
S’accorder du temps pour effectuer des revues courtes et fréquentes vous aidera à améliorer la qualité du codebase.
Vérifier pas plus de 400 lignes à la fois
Si vous essayez de revoir trop de lignes de code à la fois, vous aurez moins de chances de trouver des défauts. Essayez de limiter chaque session de révision à 400 lignes ou moins. La fixation d’une limite de lignes de code (LOC) est importante pour les mêmes raisons que la fixation d’une limite de temps. Elle permet de s’assurer que vous êtes au mieux de votre forme lorsque vous révisez le code.
Se concentrer sur moins de 400 lignes rend vos révisions plus efficaces. Et cela vous aide à assurer une plus grande qualité dans la base de code.
Donner un feedback qui aide (et non qui nuit)
Essayez d’être constructif dans votre feedback, plutôt que critique. Vous pouvez le faire en posant des questions, plutôt qu’en faisant des déclarations. Et n’oubliez pas de faire des éloges en même temps que vos commentaires constructifs.
Donner du feedback en personne (ou même faire votre revue en personne) vous aidera à communiquer avec le bon ton.
Votre code aura toujours besoin d’être revu. Et vous aurez toujours besoin de réviser le code de vos collègues. Lorsque vous abordez les revues comme un processus d’apprentissage, tout le monde est gagnant.
📕 Ressource connexe : Défi des développeurs : Vos revues de code sont-elles efficaces ?
Bonnes pratiques pour savoir comment mener une revue de code
Mener une revue de code – et s’assurer que tout a été correctement examiné – peut être un énorme défi.
Suivez ces quatre meilleures pratiques pour savoir comment diriger une revue de code.
Communiquez les objectifs et les attentes
Vous devez être clair sur les objectifs de la revue, ainsi que sur les attentes des réviseurs. Donner une liste de contrôle à vos examinateurs permettra d’assurer la cohérence des examens. Les programmeurs évalueront le code des autres avec les mêmes critères en tête.
En communiquant les objectifs et les attentes, tout le monde gagne du temps. Les examinateurs sauront ce qu’ils doivent rechercher – et ils pourront utiliser leur temps judicieusement dans le processus d’examen.
Inclure tout le monde dans le processus d’examen du code
Quel que soit le niveau d’ancienneté du programmeur, tout le monde doit examiner et être examiné. Après tout, tout le monde est plus performant lorsqu’il sait que quelqu’un d’autre examinera son travail.
Lorsque vous effectuez des revues, il est préférable d’inclure à la fois un autre ingénieur et l’architecte logiciel. Ils repéreront différents problèmes dans le code, par rapport à la fois à la base de code plus large et à la conception globale du produit.
Inclure tout le monde dans le processus de révision améliore la collaboration et les relations entre les programmeurs.
▶️ Commencez votre essai gratuit d’Helix Swarm >>
.>
Favoriser une culture positive
Favoriser une culture positive autour des avis est important, car ils jouent un rôle essentiel dans la qualité du produit. Il importe peu de savoir qui a introduit l’erreur. Ce qui compte, c’est que le bug ait été attrapé avant d’être intégré au produit. Et cela devrait être célébré.
En favorisant une culture positive, vous aiderez votre équipe à apprécier (plutôt que redouter) les revues.
Automatiser pour gagner du temps
Il y a des choses que les réviseurs devront vérifier dans les revues manuelles. Mais il y a des choses qui peuvent être vérifiées automatiquement en utilisant les bons outils.
Les analyseurs statiques de code, par exemple, trouvent des problèmes potentiels dans le code en le vérifiant par rapport aux règles de codage. L’exécution d’analyseurs statiques sur le code minimise le nombre de problèmes qui atteignent la phase de révision par les pairs. L’utilisation d’outils pour des examens légers peut également aider.
En utilisant des outils automatisés, vous pouvez gagner du temps dans le processus de révision par les pairs. Cela libère les réviseurs pour qu’ils se concentrent sur les problèmes que les outils ne peuvent pas trouver – comme l’utilisabilité.
📕 Contenu connexe : Comment faire des revues de code
Appliquer les meilleures pratiques de revue de code avec les bons outils
Si vous voulez appliquer les meilleures pratiques de revue de code, vous aurez besoin des meilleurs outils.
Une meilleure revue de code commence par les outils Perforce
Perforce dispose d’outils pour améliorer votre processus de revue du début à la fin.
Comment les analyseurs statiques de Perforce améliorent les revues de code dès le début
Les analyseurs statiques de Perforce – Helix QAC pour C/C++ et Klocwork pour C, C++, C# et Java – peuvent être utilisés pour analyser le code et éliminer les erreurs de codage avant que le code n’arrive à la phase de revue par les pairs.
Les deux s’assurent que votre code est conforme aux règles de codage. Et il met en évidence et priorise les problèmes qui doivent être corrigés, afin que les programmeurs puissent être plus efficaces dans le processus de révision.
Les réviseurs peuvent ajouter leurs annotations dans le code source – aux côtés des messages de diagnostic de Perforce Static Analyzers. Et les programmeurs reçoivent des notifications lorsque les Static Analyzers trouvent des problèmes qui concernent leur portion de code.
Comment Helix Swarm facilite la collaboration
Helix Swarm est un outil de révision de code basé sur le web qui est inclus dans Helix Core. Vous pouvez l’utiliser pour faire évoluer les revues à mesure que votre équipe s’agrandit et améliorer la collaboration pendant le processus.
Helix Swarm facilite l’exécution des revues en automatisant le processus. Les équipes peuvent utiliser cet outil pour suivre la progression et voir celles qui sont terminées – et celles qui sont encore en cours.
Les réviseurs reçoivent des notifications automatiques sur leurs tâches et un tableau de bord de leurs actions. De plus, tout le monde peut facilement collaborer en ayant des conversations directement dans le code. Voyez par vous-même comment Helix Swarm peut vous aider.
▶️ Regardez une démonstration d’Helix Swarm
Enforcez les meilleures pratiques de revue de code avec l’analyse statique
Les analyseurs de code statique de Perforce – Helix QAC et Klocwork – et Helix Swarm s’intègrent à Jenkins et à d’autres build runners. Ainsi, vous pouvez exécuter des builds et des tests avant vos cycles de revue par les pairs.
L’utilisation des outils de revue de code Perforce élimine les temps d’attente et vous aide à mieux collaborer tout au long du processus. Découvrez par vous-même comment les analyseurs statiques Perforce vous aideront.
▶️ analyse de code statique essai gratuit
.