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.
Cet article fournit des définitions pour les métriques et les évaluations utilisées par Code Quality.
Vous pouvez voir les résultats basés sur des règles pour votre référentiel sous votre Security and quality onglet, sous l’onglet Résultats standard « Qualité du code ».
Définitions de mesures
Le tableau suivant fournit des définitions pour chaque métrique signalée pour votre référentiel.
| Unité de mesure | Definition | Exemples de résultats |
|---|---|---|
| Fiabilité | Évaluez si le code effectue sa fonction prévue correctement, de manière prévisible et cohérente. Le code fiable est exempt de bogues, gère les erreurs en toute sécurité et fonctionne comme prévu dans des conditions normales et de cas de périphérie. | Problèmes liés aux performances, à la concurrence, à la gestion des erreurs, à la correction, à la conception de l’API, à l’accessibilité, à l’internationalisation ou à la sécurité |
| Maintenabilité | Évaluez la facilité de compréhension, de modification et d’extension du code au fil du temps. Le code gérable suit les meilleures pratiques, évite la complexité inutile et est organisé pour faciliter les modifications et la collaboration futures. | Ne pas utiliser les meilleures pratiques, le code inutilisé/mort, le code en double, la complexité, les redondances logiques, la documentation insuffisante, les problèmes de dépendance |
Niveaux de gravité
Les niveaux de gravité sont utilisés pour indiquer l’impact potentiel ou l’urgence d’une recherche de qualité du code. Ils aident les utilisateurs à hiérarchiser les efforts de correction et à communiquer les risques aux parties prenantes. La gravité est déterminée par la règle qui a détecté le problème, suivant les conventions de CodeQL et les normes du secteur.
| Niveau de gravité | Definition |
|---|---|
| Error | Indique un problème de gravité élevée susceptible d’entraîner des bogues, des défaillances ou des risques de maintenance majeurs. |
| Avertissement | Indique un problème de gravité modérée qui peut avoir un impact sur la qualité ou la fiabilité du code, mais n’est pas immédiatement critique. |
| Remarque | Indique un problème de faible gravité, une amélioration mineure ou une recommandation. Ces résultats sont utiles pour assurer la maintenance et l’intégrité du code en cours. |
Définitions des évaluations
Ces évaluations sont utilisées pour résumer la fiabilité globale et la maintenabilité d’un référentiel en fonction de la gravité des résultats basés sur des règles trouvés par les analyses CodeQL de la totalité de la branche par défaut :
| Évaluation | Definition | Critères (en fonction des résultats) |
|---|---|---|
| Excellent | Codebase illustre les meilleures pratiques en matière de fiabilité et de maintenance. | Aucun résultat de qualité du code n’a été détecté |
| Bon | Codebase présente des problèmes de faible gravité ou des améliorations mineures sont suggérées. | ≥1 recherche de niveau « Note » |
| Moyen | Codebase présente des problèmes de gravité modérée qui peuvent avoir un impact sur la qualité, mais ne sont pas critiques. | ≥1 résultat de niveau « Avertissement » |
| Besoin d'amélioration | Codebase présente des problèmes de gravité élevé, notamment des bogues ou des risques de maintenance majeurs. | ≥1 résultat de niveau « Erreur » |