Correction des problèmes de qualité du code avant de fusionner votre pull request

Présentation

Ce tutoriel vous montre comment utiliser GitHub Code Quality sur les pull requests pour identifier les problèmes de qualité du code que vos modifications peuvent introduire par inadvertance, et comment aborder et résoudre les résultats de qualité du code avec Copilot correction automatique et Agent cloud Copilot.

Avantages de la prise en compte précoce des problèmes

Détecter tôt les problèmes de qualité du code maintient la base de code de votre équipe optimale. GitHub Code Quality vérifie votre code pour :

• Fiabilité : Par exemple, les erreurs logiques, la gestion des erreurs non sécurisées ou les conditions de concurrence susceptibles de provoquer un blocage ou un comportement imprévisible de votre application. En répondant rapidement à ce type de problème, vous rendez votre logiciel plus robuste et fiable pour les utilisateurs.
• Facilité de maintenance : par exemple, du code en double, une logique trop complexe, des variables inutilisées ou des violations des bonnes pratiques de codage. La résolution de ces problèmes rend votre code plus propre et plus facile à lire, de sorte que les modifications futures sont plus rapides et moins risquées.

1. Comprendre le GitHub Code Quality fonctionnement des demandes de tirage

Lorsque vous ouvrez une pull request, GitHub Code Quality utilise CodeQL pour analyser automatiquement vos modifications afin de détecter les problèmes de qualité tels que ceux décrits plus haut.

Les résultats de CodeQL l’analyse sont présentés sous forme de commentaires sur votre requête pull, laissés par le github-code-quality[bot]. Chaque commentaire correspond à un problème de qualité de code spécifique détecté dans vos modifications et est fourni avec une correction automatique suggérée.

Les commentaires sont étiquetés par gravité (Erreur, Avertissement, Remarque), de sorte que vous pouvez voir quels résultats sont les plus critiques à traiter.

2. Hiérarchiser les correctifs en fonction de la gravité

Analysez les commentaires et identifiez d’abord les résultats dont le niveau de gravité est le plus élevé (« Erreur »).

S’il n’y a pas de résultats « Erreur », recherchez les résultats du niveau de gravité suivant (« Avertissement »), et ainsi de suite.

Les résultats de gravité élevée indiquent des problèmes de qualité de code plus graves qui sont plus susceptibles d’introduire des problèmes de fiabilité ou de maintenance dans votre base de code. En résolvant les résultats de gravité élevée, vous effectuez le travail le plus impactant pour maintenir la qualité du code de votre équipe.

3. Tirer parti de Copilot correction automatique ou de Agent cloud Copilot pour corriger les résultats.

Copilot correction automatique

Les commentaires sur le pull request incluent une autocorrection suggérée que vous pouvez commettre directement dans votre pull request. Examinez attentivement la correction automatique suggérée pour la logique, la sécurité et le style, puis cliquez sur Valider la suggestion.

Vous n’avez pas besoin d’une licence Copilot pour appliquer ces suggestions.

Agent cloud Copilot

Sinon, si vous disposez d’une Copilot licence, vous pouvez déléguer le travail de correction à Agent cloud Copilot. Commentez la pull request en mentionnant @Copilot et demandez à Copilot de corriger les problèmes détectés.

          Copilot répond avec un émoji de yeux (👀) à votre commentaire, démarre une nouvelle session pour l'agent et ouvre un pull request avec les correctifs nécessaires.

Vous pouvez suivre Agent cloud Copilotle travail :

• Dans le pull request, le résumé est mis à jour à mesure de l'avancement du travail.
• À l’aide de la page des agents ou des journaux de session, consultez Suivi des sessions de GitHub Copilot.

Vous avez besoin d’une Copilot licence pour appeler Agent cloud Copilot.
S’inscrire Copilot

4. Ignorer les résultats non pertinents

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.

5. Poussez les modifications et attendez l’analyse

Après avoir corrigé ou rejeté les constats, poussez vos modifications vers la branche associée à votre pull request. GitHub Code Quality analysera automatiquement vos modifications et mettra à jour les commentaires sur votre pull request en fonction des changements.

6. Vérifiez les évaluations de qualité du code de votre référentiel

Toute personne disposant d’un accès en écriture peut afficher les évaluations globales de qualité du code pour un référentiel, qui résument l’état de la fiabilité et de la maintenance du code dans la branche par défaut.

Pour afficher les évaluations de votre référentiel, accédez à l’onglet Security and quality de votre référentiel, développez-le Qualité du code dans la barre latérale, puis cliquez sur Résultats standard.

En résolvant les problèmes avant de fusionner votre pull request, vous avez directement contribué au maintien de ces évaluations.

Étapes suivantes

• Traitez les problèmes de qualité du code dans votre branche par défaut et comprenez les évaluations de fiabilité et de maintenabilité de votre référentiel. Consultez Amélioration de la qualité du code de votre référentiel.
• Donnez des commentaires sur GitHub Code Quality dans la discussion communautaire.