Amélioration de la qualité du code de votre référentiel

Présentation

Ce tutoriel vous guide tout au long de l’utilisation GitHub Code Quality pour passer en revue, hiérarchiser et corriger les problèmes d’intégrité du code dans votre référentiel , ce qui vous aide à réduire systématiquement la dette technique, à améliorer la fiabilité et la maintenance, et à communiquer votre impact aux parties prenantes.

Prerequisites

• Code Quality est activé pour votre référentiel. Consultez Activation de GitHub Code Quality.
• Si vous activez GitHub Code Quality pour la première fois, assurez-vous d'avoir patienté quelques minutes après l'activation pour permettre à une analyse complète CodeQL de la branche par défaut de se terminer.

1. Évaluer l’intégrité globale du code de votre référentiel

1. Accédez à l’onglet Security and quality de votre référentiel, puis sous « », Qualité du code cliquez sur Résultats standard.

2. La vue d’ensemble du tableau de bord «Résultats standard » vous donne une évaluation immédiate de l’état de votre branche par défaut aujourd’hui :

   •      **L’évaluation** de la facilité de maintenance reflète la présence et la gravité des résultats pour le code mort, la duplication, la complexité, la documentation manquante et l’échec de suivre les meilleures pratiques.
     

   •      **L’évaluation de la fiabilité** reflète la présence et la gravité des résultats pour l’exactitude, les performances, la gestion des erreurs, la concurrence et l’accessibilité de votre code.
     

   

2. Identifier et hiérarchiser les résultats les plus impactants

Dans la vue « Résultats standard », vous pourrez voir la liste des résultats de la dernière analyse effectuée par Code Quality de la branche principale du référentiel. Ces résultats sont les suivants :

• Regroupés par règle, vous pouvez donc voir quels types de problème affectent le plus votre codebase.
• Affecté à un niveau de gravité (« Erreur », « Avertissement », « Remarque »).

Concentrez-vous sur les résultats de gravité élevée

Utilisez les filtres de tableau de bord pour vous concentrer sur les résultats de gravité les plus élevés en premier (« Erreurs »), puis passez en revue les règles qui génèrent le plus de problèmes.

Pour améliorer la facilité de maintenance ou la fiabilité de votre référentiel, vous devez résoudre (corriger ou ignorer) toutes les résultats ayant le niveau de gravité le plus élevé pour cette métrique.

Par exemple, pour améliorer la métrique de "Fiabilité" de votre référentiel de Besoin d'amélioration à Correct, vous devez identifier et résoudre toutes les détections de niveau d'erreur qui impactent la fiabilité. Si vous avez un ou plusieurs résultats au niveau de l’erreur, votre évaluation ne peut pas être supérieure à « Besoin d’amélioration ». Consultez Informations de référence sur les métriques et les évaluations.

3. Examiner un groupe de résultats et comprendre le contexte

Une fois que vous avez identifié une règle avec plusieurs résultats que vous souhaitez résoudre, vous pouvez examiner plus en détail les problèmes sous-jacents.

1. Cliquez sur le nom de la règle pour obtenir une vue détaillée de toutes les conclusions de cette règle.

   

2. Cliquez sur Afficher plus, puis passez en revue l’explication de la règle, la recommandation de solution, ainsi que les exemples de code et les références.

   

4. Choisir les options de correction

Évaluez toutes les conclusions mises en évidence pour la validité, l’impact et le risque. Pour améliorer votre notation de la qualité, vous devez résoudre chaque constatation en choisissant de corriger ou de l'ignorer.

Générer une correction automatique

Si la recherche semble valide et pertinente pour votre codebase, vous pouvez générer un correctif suggéré.

1. À droite d’une recherche individuelle, cliquez sur Générer un correctif.

2. Passez en revue attentivement les différences de la modification proposée et, si vous êtes d’accord, cliquez sur Ouvrir la pull request.

3. Dans la boîte de dialogue « Valider la correction automatique dans la branche », sélectionnez « Ouvrir une requête de tirage », puis cliquez sur Valider la modification.

   Conseil

   Il n’est actuellement pas possible de générer des corrections automatiques pour un groupe de résultats en bloc.

   Si vous souhaitez traiter plusieurs résultats avec une demande de tirage unique, répétez les étapes 1 et 2 ci-dessus, puis, dans la boîte de dialogue « Valider la correction automatique dans la branche », utilisez le nom de branche que vous avez déjà créé pour le premier correctif automatique, puis sélectionnez « Ouvrir la demande de tirage » et Valider la modification.

   Le correctif sera ajouté au brouillon déjà existant du pull request pour votre branche.

4. Lorsque vous êtes prêt, modifiez le statut de la requête de tirage de « Brouillon » à « Prêt pour examen », et examinez attentivement les modifications proposées. Attendez que les vérifications CI et les tests automatisés se terminent et réussissent avant de fusionner la pull request.

Rejeter une constatation

Vous pouvez ignorer une recherche si elle n’est pas pertinente ou actionnable dans le contexte de votre codebase. Les raisons courantes d’ignorer une recherche sont les suivantes :

• La découverte se trouve dans le code ancien qui n’est plus maintenu.
• Il s’agit d’une exception connue des normes de codage de votre équipe.
• C’est un faux positif qui ne pose pas de risque de qualité réelle.

Si vous ignorez les alertes non pertinentes, vos vérifications de qualité se concentrent sur des problèmes significatifs.

1. Pour ignorer une constatation, cliquez sur .
2. La recherche disparaîtra de la liste des résultats ouverts. Vous pouvez toujours examiner et rouvrir les résultats ignorés sous l’onglet « Ignoré » en haut de la page.

5. Mesurer l’amélioration et communiquer l’impact

Une fois le travail de correction terminé, revenez au tableau de bord «Résultats standard » pour passer en revue les métriques de fiabilité et de maintenance mises à jour.

Lorsque vous communiquez votre impact aux parties prenantes, mettez en évidence :

• Toute réduction du nombre de résultats pour la « fiabilité » ou la « facilité de maintenance ».
• Toute modification de l’évaluation pour les évaluations de fiabilité ou de maintenance.
• Conditions requises pour obtenir la modification de l’évaluation. Par exemple, la correction de toutes les conclusions de niveau « Avertissement » a provoqué le passage de « Juste » à « Bon ».

Utilisez les améliorations apportées aux évaluations de qualité et à la réduction du nombre de résultats pour démontrer la progression.

6. Appliquer les normes de qualité du code pour les pull requests

Si vous ne l’avez pas encore fait, configurez des seuils de qualité pour les demandes d’extraction afin de bloquer les modifications apportées à la base de code qui réduira l’intégrité de votre codebase. Consultez Définition des seuils de qualité du code pour les pull requests.

Étapes suivantes

• Réduisez davantage la dette technique en corrigeant les résultats dans les fichiers récemment modifiés. Consultez Amélioration de la qualité du code récemment fusionné avec l’IA.
• Donnez des commentaires sur GitHub Code Quality dans la discussion communautaire.