Examiner les fonctionnalités de révision de code GitHub Copilot
GitHub Copilot peut examiner votre code et fournir des commentaires.
La révision de code avec GitHub Copilot dans Visual Studio Code offre deux types de révision :
- Sélection de révision : Mettez en surbrillance le code et demandez une révision initiale.
- Passer en revue les modifications : demandez un examen plus approfondi de toutes vos modifications.
La fonctionnalité et la disponibilité actuelles des deux types d'examen sont résumées dans le tableau suivant :
| Caractéristique | Révision de la sélection | Examiner les modifications |
|---|---|---|
| Disponible dans | Visual Studio Code | Visual Studio Code et le site web GitHub |
| Fonctionnalité Premium/standard | Fonctionnalité standard disponible pour tous les abonnés GitHub Copilot | Fonctionnalité Premium. Disponible avec les offres GitHub Copilot Pro, GitHub Copilot Pro+, GitHub Copilot Business et GitHub Copilot Entreprise. Un quota mensuel par personne s’applique. |
| Description | Examen initial d’une section de code mise en surbrillance avec commentaires et suggestions | Examen approfondi de tous les changements |
| Prise en charge linguistique | Tous | C, C#, C++, Go, Java, JavaScript, Kotlin, Markdown, Python, Ruby, Swift, TypeScript. |
| Prise en charge des instructions de codage personnalisées | Non | Oui |
Quota mensuel de revue
Le type de révision de code de GitHub Copilot est une fonctionnalité premium avec un quota mensuel par personne. Le quota est actuellement actif.
Lorsque vous attribuez GitHub Copilot en tant que réviseur pour une demande de tirage, une demande Premium est déduite de votre quota mensuel chaque fois que GitHub Copilot publie des commentaires sur la demande de tirage.
Si un référentiel est configuré pour demander automatiquement une révision de code à partir de GitHub Copilot pour toutes les nouvelles demandes de tirage, l’utilisation de la demande Premium est appliquée au quota de l’auteur de la demande de tirage. Si une pull request est créée par GitHub Actions ou par un bot, l'utilisation s'applique à l'utilisateur qui a initié le workflow (s'il est identifiable) ou à un propriétaire de facturation désigné.
Lorsque vous atteignez votre quota mensuel, vous ne pourrez pas obtenir une révision du code de GitHub Copilot jusqu’à ce que votre quota soit réinitialisé, sauf si vous mettez à niveau votre plan de GitHub Copilot ou activez plus de demandes Premium.
Avertissement
GitHub Copilot ne garantit pas de repérer tous les problèmes ou questions dans une pull request, et parfois il fait des erreurs. Validez toujours attentivement les commentaires de GitHub Copilot et complétez les commentaires de GitHub Copilot avec une révision humaine.
Utiliser les fonctionnalités de révision de code
GitHub Copilot peut vous aider à examiner votre code, soit pour un bloc de code que vous sélectionnez dans l’éditeur, soit pour toutes les modifications incluses dans une pull request (nécessite l’extension GitHub Pull Requests).
Passer en revue un bloc de code sélectionné dans l’éditeur de code
L’action intelligente De révision permet de passer en revue et d’analyser votre code. Il peut vous aider à identifier les domaines d’amélioration, à suggérer des mises à jour de refactorisation et à fournir des conseils sur les meilleures pratiques. Les suggestions générées par la fonctionnalité de révision de code peuvent vous aider à améliorer la qualité, la fiabilité, les performances et la sécurité de votre code.
Ouvrez un fichier de code dans l’éditeur.
Sélectionnez le code que vous souhaitez examiner.
Cliquez avec le bouton droit sur le code sélectionné, puis sélectionnez Générer la révision du code>.
L’agent de révision du code crée des commentaires de révision dans le panneau COMMENTAIRES (sous l’éditeur de code) et affiche les mises à jour suggérées inline dans l’éditeur de code.
Remarque
Le menu contextuel Visual Studio Code pour GitHub Copilot est mis à jour activement. L'action intelligente Review peut apparaître au niveau supérieur du menu contextuel (à côté de Expliquer) plutôt que sous Générer du code. Si l’option Révision n’est pas disponible dans le menu contextuel, vous pouvez effectuer la même action en sélectionnant votre code et en entrant une invite comme « vérifier ce code » directement dans la vue Conversation.
Parcourez les suggestions et appliquez ou ignorez les mises à jour.
Si possible, les commentaires de Copilot incluent des modifications de code suggérées. Utilisez Apply and Go To Next pour accepter une suggestion, ou Ignorer et Accéder à Suivant pour le rejeter. Les modifications appliquées ne sont pas validées automatiquement.
Passez en revue toutes les modifications apportées à votre codebase
La fonctionnalité GitHub Copilot révision du code permet de passer en revue toutes les modifications intermédiaires ou non mises en scène de votre codebase. Il peut vous aider à identifier les domaines d’amélioration, à suggérer des mises à jour de refactorisation et à fournir des conseils sur les meilleures pratiques. Les suggestions générées par la fonctionnalité de révision de code peuvent vous aider à améliorer la qualité, la fiabilité, les performances et la sécurité de votre code.
Dans Visual Studio Code, basculez vers la vue Contrôle de code source.
Pour demander une révision de vos modifications non modifiées, placez le pointeur de la souris sur CHANGES, puis sélectionnez le bouton GitHub Copilot Révision du code - Modifications non validées.
Attendez que GitHub Copilot passe en revue vos modifications. Cette opération prend généralement moins de 30 secondes.
Si GitHub Copilot a des commentaires, ils s’affichent en ligne dans votre ou vos fichiers et sous l’onglet Problèmes.
Si possible, les commentaires de Copilot incluent des modifications de code suggérées. Utilisez Apply and Go To Next pour accepter une suggestion, ou Ignorer et Accéder à Suivant pour le rejeter. Les modifications appliquées ne sont pas validées automatiquement.
Personnaliser la révision du code avec des instructions de codage
Vous pouvez personnaliser la façon dont Copilot passe en revue votre code en ajoutant des instructions personnalisées à votre référentiel. Ceci est pris en charge pour le type de révision Examiner les modifications.
Spécifiez des instructions personnalisées à l’échelle du référentiel dans un .github/copilot-instructions.md fichier. Par exemple:
When performing a code review, focus on readability and avoid nested ternary operators.
When performing a code review, flag any use of hardcoded credentials.
Vous pouvez également créer des instructions spécifiques au chemin d’accès dans .github/instructions/**/*.instructions.md fichiers que Copilot utilise uniquement lors de l’examen des fichiers qui correspondent à un chemin d’accès spécifié.
Remarque
La révision de code Copilot lit uniquement les 4 000 premiers caractères d’un fichier d’instructions personnalisé. Les instructions au-delà de cette limite n’affectent pas les révisions générées.
Résumé
GitHub Copilot peut passer en revue votre code et fournir des commentaires. La révision de code GitHub Copilot dans Visual Studio Code prend en charge deux types de révision : réviser la sélection et réviser les modifications. L'action intelligente Review fournit un moyen d’examiner et d’analyser le code sélectionné. Il peut vous aider à identifier les domaines d’amélioration, à suggérer des mises à jour de refactorisation et à fournir des conseils sur les meilleures pratiques. La fonctionnalité GitHub Copilot révision du code permet d'examiner les modifications intermédiaires ou non mises en scène à l'aide de la vue contrôle de code source de Visual Studio Code.