Interprétation des résultats de qualité du code pour votre référentiel

Affichez GitHub Code Quality résultats pour votre branche par défaut.

Qui peut utiliser cette fonctionnalité ?

Utilisateurs avec accès en écriture

GitHub Team ou GitHub Enterprise Cloud

Dans cet article

Remarque

GitHub Code Quality est actuellement dans préversion publique et peut être modifié. Pendant préversion publique, Code Quality ne sera pas facturé, bien que les analyses Code Quality consomment GitHub Actions minutes.

Prerequisites

Affichage du backlog complet des résultats de qualité du code

  1. Accédez à l’onglet Security and quality de votre référentiel.
  2. Cliquez pour développer Qualité du code, puis cliquez sur Résultats standard.

Sinon, si vous souhaitez afficher les résultats basés sur l’IA pour les fichiers les plus récemment modifiés, consultez Amélioration de la qualité du code récemment fusionné avec l’IA.

Exploration du backlog de votre dépôt

Le tableau de bord « Résultats standard » affiche tous les résultats trouvés par l'analyse CodeQL sur la branche par défaut de votre dépôt. Cette vue vous aide à visualiser le backlog complet des résultats de qualité et à hiérarchiser le travail pour résoudre des types de problèmes spécifiques.

La vue d’ensemble, en haut de la page, résume la facilité de maintenance et la fiabilité de la base de code.

Capture d’écran du tableau de bord « Résultats standard » des résultats relatifs à la qualité du code. Le résumé est décrit en orange foncé.

Sous la vue d’ensemble, la liste complète des résultats s’affiche avec un en-tête avec des filtres que vous pouvez utiliser pour vous concentrer sur un ensemble spécifique de résultats. Les résultats sont les suivants :

  • Regroupé par la règle qui a détecté chaque recherche
  • Dans chaque règle, tri par chemin d'accès au fichier par ordre alphabétique

Explorez les résultats en développant une règle pour répertorier les fichiers concernés et en cliquant sur le nom d’une règle pour afficher les détails complets des résultats.

Capture d’écran du tableau de règles du tableau de bord « Résultats standard » destiné à la qualité du code. Le nom de la règle « Propriété remplacée » est surligné en orange foncé.

Interprétation des évaluations et des métriques

Les résultats de qualité du code doivent toujours être interprétés dans le contexte de votre référentiel. Par exemple:

  • Les petits référentiels ou référentiels avec seulement une petite quantité de code écrit dans les langues prises en charge ont tendance à avoir peu de résultats et de bonnes évaluations.
  • Les dépôts avec beaucoup de code généré peuvent avoir de nombreuses implications en matière de maintenance, ce qui diminue l'évaluation de la maintenabilité. Ce n’est pas un problème si le code source lui-même est gérable.
  • Les grands référentiels avec beaucoup de code dans un langage entièrement pris en charge ont souvent de nombreux résultats, même si la majorité du code a de bonnes normes de maintenance et de fiabilité.

Pour en savoir plus sur les métriques et la façon dont les évaluations sont calculées, consultez Informations de référence sur les métriques et les évaluations.

Étapes suivantes