Présentation
GitHub Code Quality (préversion publique) permet de maintenir votre code fiable et maintenable en exposant les résultats de qualité du code dans les requêtes de fusion et dans votre branche par défaut.
Dans ce tutoriel, vous allez apprendre à identifier et corriger un constat de qualité du code sur votre branche par défaut, aidant à améliorer la santé du code de votre référentiel.
Prerequisites
- GitHub Code Quality doit être activé pour votre référentiel et vous devez avoir du code dans une langue prise en charge. 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.
Passer en revue les résultats de l’analyse pour votre branche par défaut
Dans votre référentiel, accédez à l’onglet Security and quality , cliquez Qualité du code dans la barre latérale gauche, puis cliquez pour Résultats standard ouvrir le tableau de bord du référentiel.
Ici, vous verrez :
-
Évaluations pour la fiabilité et la maintenance de votre codebase, ce qui vous aide à comprendre l’intégrité de votre code en un clin d’œil.
-
Une liste des résultats de tous les problèmes de qualité détectés par une analyse alimentée par CodeQL sur votre branche par défaut, qui sont regroupés par règle et langue.
Identifier une recherche à impact élevé
Utilisez les filtres de tableau de bord pour identifier une recherche de niveau de gravité élevé (« Erreur » ou « Avertissement »).
La résolution de ces problèmes aura le plus d’impact sur les évaluations de votre référentiel.
Inspecter les détails de la recherche
Cliquez sur le nom de la règle lui-même pour afficher une vue détaillée des fichiers et lignes de code affectés par cette règle.
Une fois que vous êtes dans l’affichage détaillé, cliquez sur Afficher plus pour collecter le contexte et comprendre les résultats.
Générer un Copilot correction automatique
À droite d’une recherche mise en surbrillance, cliquez sur Générer un correctif.
Passez en revue le correctif suggéré, puis cliquez sur Ouvrir la demande de tirage.
Fusionner le correctif
Examinez attentivement le brouillon de pull request. Si vous êtes satisfait des modifications proposées et que toutes les vérifications et tests passent, continuez et fusionnez le pull request.
Observer la modification des métriques
Revenez au Code Quality tableau de bord ( Security and quality onglet, puis Qualité du code, puis Résultats standard).
Patientez quelques minutes pour que l’analyse suivante se termine : Code Quality les analyses sont automatiquement réexécuter après chaque envoi (push) vers la branche par défaut.
Observez la modification des métriques en haut du tableau de bord :
-
Le nombre de résultats pour la « fiabilité » ou la « facilité de maintenance » devrait avoir diminué.
-
Vos évaluations relatives à la « fiabilité » ou à la « facilité de maintenance » peuvent avoir été améliorées, si votre correctif a résolu un certain nombre de résultats à fort impact.
Pour en savoir plus sur la façon dont les évaluations sont calculées, consultez Informations de référence sur les métriques et les évaluations.
Conclusion
Vous avez réussi à utiliser Code Quality et Copilot correction automatique pour améliorer l’intégrité du code de votre dépôt.
Le code sain est plus facile à comprendre, à gérer et à étendre, et à corriger les problèmes de qualité du code rend votre codebase plus fiable, conforme et accélère le développement futur.
Étapes suivantes
- Découvrez comment GitHub Code Quality fonctionne sur les pull requests pour empêcher que les problèmes de qualité du code n’atteignent votre branche par défaut. Consultez Correction des problèmes de qualité du code avant de fusionner votre pull request.
- Donnez des commentaires sur GitHub Code Quality dans la discussion communautaire.