Revues de code et approbations

Les examens de code sont essentiels au développement logiciel moderne. Il s’agit d’un examen systématique du code source par des pairs afin de trouver et de corriger les erreurs passées inaperçues lors de la phase de développement initiale.

Les principaux objectifs sont notamment les suivants :

• Améliorer la qualité du code : détecter rapidement les bogues, les failles de sécurité et les défauts de conception.
• Partager les connaissances : diffuser la compréhension du code source dans toute l’équipe.
• Assurer un mentorat : les développeurs expérimentés peuvent guider les débutants, et chacun apprend de points de vue différents.

Sur GitHub, le processus d’examen du code suit généralement les étapes suivantes :

1. Un auteur crée une demande de fusion (PR) contenant ses modifications.
2. L’auteur désigne des évaluateurs ou leur demande d’examiner le code.
3. Les évaluateurs examinent le code et laissent des commentaires et des suggestions.
4. L’auteur prend en compte les retours en envoyant de nouvelles validations vers la branche de la PR.
5. Une fois satisfaits, les évaluateurs approuvent les modifications.
6. Enfin, la PR est fusionnée dans la branche principale.

Un bon examen de code ne consiste pas seulement à trouver des bogues ; il vise à améliorer la santé globale du projet. Lors de votre examen, tenez compte des éléments suivants :

• Exactitude : le code fait-il ce qu’il est censé faire ? Existe-t-il des cas limites ?
• Lisibilité : est-il facile à comprendre ? Les noms de variables sont-ils clairs ?
• Facilité de maintenance : d’autres personnes pourront-elles facilement modifier ou étendre ce code plus tard ?
• Performances : existe-t-il des inefficacités évidentes ?
• Sécurité : le code introduit-il des failles ?

En tant qu’évaluateur, votre retour doit toujours être constructif et respectueux. N’oubliez pas que vous examinez le code, et non la personne qui l’a écrit.

Conseils pour fournir un retour :

• Soyez précis : indiquez les lignes exactes du code.
• Expliquez le « pourquoi » : ne dites pas seulement « modifiez ceci » ; expliquez pourquoi cette modification est nécessaire.
• Proposez des solutions : suggérez d’autres approches ou des extraits de code.
• Soyez bienveillant : employez un langage poli et présumez de bonnes intentions.

GitHub fournit des outils puissants pour simplifier le processus d’examen :

• Commentaires sur les lignes : cliquez sur une ligne dans l’onglet « Fichiers modifiés » pour ajouter directement un commentaire.
• Suggestions : vous pouvez proposer des modifications précises du code que l’auteur pourra appliquer en un seul clic.
• Examen récapitulatif : à la fin, vous pouvez envoyer un examen récapitulatif avec le statut « Commenter », « Approuver » ou « Demander des modifications ».

Les suggestions sont particulièrement utiles pour les petites améliorations claires :

// Original Code
- const count = 0;
+ const initialCount = 0; // Better name

Si vous êtes l’auteur d’une demande de fusion, il est essentiel de répondre aux retours. Cela montre que vous êtes impliqué et déterminé à améliorer le code.

Lorsque vous répondez aux commentaires :

• Accusez réception : répondez à chaque commentaire, même si c’est simplement pour dire « Bonne remarque ! » ou « C’est fait ».
• Effectuez les modifications : envoyez de nouvelles validations vers la branche de votre PR. GitHub met automatiquement la PR à jour.
• Résolvez les conversations : une fois un commentaire traité, marquez-le comme « Résolu » sur GitHub.
• Posez des questions : si vous ne comprenez pas une suggestion, demandez des précisions.

Le statut « Approuver » indique clairement qu’un évaluateur est satisfait des modifications d’une demande de fusion. De nombreux dépôts sont configurés pour exiger au moins une approbation, voire plusieurs, avant qu’une PR puisse être fusionnée.

Une approbation indique que l’évaluateur estime que le code :

• Respecte les exigences.
• Est bien écrit et facile à maintenir.
• A répondu à toutes les préoccupations importantes.

C’est le feu vert pour l’intégration !

Parfois, une demande de fusion nécessite davantage de travail avant de pouvoir être fusionnée. Dans ce cas, un évaluateur peut choisir « Demander des modifications » comme statut de son examen.

Ce statut indique clairement que :

• Des problèmes bloquants doivent être résolus.
• La PR ne peut pas être fusionnée tant que ces modifications n’ont pas été effectuées et que l’évaluateur n’a pas donné une nouvelle approbation.

Utilisez cette option lorsque les problèmes sont importants et empêchent le code d’être acceptable.

Pour tirer le meilleur parti des examens de code, les auteurs comme les évaluateurs doivent suivre certaines bonnes pratiques :

• Gardez des PR de petite taille : les PR plus petites sont plus faciles et plus rapides à examiner.
• Rédigez des descriptions claires : les auteurs doivent fournir des descriptions détaillées de leurs PR ainsi que le contexte nécessaire.
• Soyez réactif : les évaluateurs doivent essayer d’examiner rapidement le code, et les auteurs doivent répondre sans tarder.
• Automatisez ce qui peut l’être : utilisez des outils d’analyse statique et des tests automatisés pour détecter les problèmes simples avant l’examen.
• Apprenez des examens : considérez chaque examen comme une occasion d’apprendre et de progresser.

Selon ce que nous avons appris, lesquelles des pratiques suivantes sont considérées comme de bonnes pratiques pour participer à des examens de code ?

Vous avez exploré l’univers des examens de code et les fonctionnalités d’approbation de GitHub ! Nous avons vu pourquoi les examens sont essentiels à la qualité du code et au partage des connaissances, le déroulement habituel d’un examen et les éléments clés des bonnes pratiques.

N’oubliez pas de toujours fournir un retour constructif, d’utiliser les outils de GitHub comme les suggestions et de suivre les bonnes pratiques, aussi bien pour examiner le code que pour répondre aux retours. Les approbations et les demandes de modifications sont des indicateurs essentiels pour gérer efficacement vos PR.

Continuez à vous exercer pour devenir un collaborateur précieux !