Revue de code

Revue des pull requests

Le plugin Revue de code affiche la description d’une pull request, les fichiers modifiés, les commentaires et les vérifications. Utilisez-le pour examiner les problèmes potentiels avant d’approuver la pull request.

La revue de code pour GitHub est disponible pour tous. Le plugin Revue de code prend en charge les demandes de fusion GitLab en préversion. Pour lancer des revues dans le cloud depuis GitLab avec @codex review ou activer les revues automatiques des demandes de fusion, consultez Passer en revue les demandes de fusion GitLab avec Codex.

Pour les revues déclenchées depuis un dépôt, consultez le guide d’intégration de GitHub et le guide de configuration de l’environnement Codex Cloud (ancienne version).

L’application de bureau ChatGPT inclut le plugin Revue de code. Depuis la liste des plugins installés, vous pouvez l’épingler à la barre latérale de l’application.

Consulter une pull request

1. Ouvrez Revue de code depuis la barre latérale.
2. Lorsque l’application vous y invite, connectez votre compte sur la plateforme qui héberge le dépôt. Utilisez un compte qui a accès au dépôt que vous souhaitez examiner.
3. Sélectionnez une pull request dans la barre latérale ou saisissez son lien dans le champ de recherche.
4. Consultez la vue Résumé pour voir la description, l’activité, les commentaires et les vérifications. Ouvrez Modifications pour examiner les fichiers modifiés et les commentaires en regard du diff.

Repérer les revues à traiter

Votre boîte de réception personnelle regroupe les pull requests GitHub de vos différents dépôts. Choisissez Qui me sont attribuées pour voir les revues qui vous ont été demandées, Attribuées à mon équipe pour celles demandées à votre équipe ou Créées par moi pour retrouver vos propres modifications. Vérifiez l’état de la revue, puis ouvrez la pull request pour consulter les commentaires et les vérifications.

Pour retrouver une revue plus tard, sélectionnez l’épingle dans sa barre d’outils. La pull request apparaît sous Épinglées dans la barre latérale.

Examiner les fichiers modifiés et les pull requests associées

Dans Modifications, sélectionnez Marquer comme vu après avoir examiné un fichier. Sélectionnez à nouveau cette commande pour retirer la marque. Elle s’applique à la révision affichée.

Si les modifications sont réparties entre plusieurs pull requests qui dépendent les unes des autres, utilisez Pile dans la vue Résumé pour ouvrir une pull request associée et examiner son diff, ses commentaires et ses vérifications. Cette section apparaît lorsque le plugin Revue de code détecte une pile de pull requests ouvertes.

Consulter une revue automatique dans le cloud

Si vous utilisez le connecteur Codex de ChatGPT, disposez des autorisations requises sur le dépôt et avez activé les revues automatiques, Codex peut examiner une pull request GitHub avant même que vous l’ouvriez. Les commentaires apparaissent sur GitHub et dans le plugin Revue de code.

Pour effectuer une revue dans le cloud, vous n’avez pas besoin de créer ni de gérer un environnement cloud. Pour connaître les conditions de connexion, les paramètres du dépôt et le fonctionnement des revues déclenchées avec @codex review, consultez Utiliser Codex dans GitHub.

Comparez les problèmes signalés au diff. Les revues automatiques dans le cloud sont distinctes de celles que vous lancez dans la discussion de la pull request.

Poser des questions sur la modification

Dans la discussion de la pull request, décrivez le comportement attendu et demandez à Codex d’expliquer ou d’examiner la modification.

Sélectionnez Passer en revue avec Codex pour lancer une revue dans une nouvelle discussion. Si la pull request est affichée à côté d’une discussion existante, utilisez cette discussion pour poser vos questions sur la modification.

Utilisez les skills installés et les sources connectées pour fournir à Codex les consignes de revue ou les documents de conception de votre équipe. Demandez-lui de résumer la modification et d’en expliquer les risques, puis vérifiez le contexte et le code auxquels il se réfère.

Par exemple, une pull request ajoute les filtres Ouverts et Fermés à un tableau de suivi des tickets. Vous vous attendez à ce que Tous reste le filtre par défaut et à ce que le tableau affiche un état vide si aucun ticket ne correspond au filtre :

Expliquez-moi cette pull request étape par étape. Concentrez-vous sur le filtre
par défaut et sur ce qui se passe lorsqu’aucun ticket ne correspond au filtre.
Le filtre « Tous » doit rester sélectionné par défaut.

Demandez des éléments concrets :

Montrez-moi le chemin d’exécution suivi lorsqu’aucun ticket ne correspond au
filtre, ainsi que les tests associés à ce cas. Expliquez ce que ces tests
couvrent et ce qui reste à vérifier.

Vérifiez que le diff et les tests cités correspondent au comportement attendu.

Sélectionnez un problème signalé pour en lire l’explication et examiner les lignes concernées dans Modifications. Comparez-le au dernier diff, au comportement attendu et aux tests avant de décider si une correction s’impose. Pour arrêter une revue en cours, utilisez la discussion associée à la revue.

Personnaliser les revues

Sélectionnez l’icône d’engrenage Consignes de revue à côté de Passer en revue avec Codex. Vous pouvez aussi modifier ces consignes dans Paramètres > Revue de code.

Indiquez à Codex les critères à appliquer à toutes vos revues et le format à utiliser pour présenter ses observations. Par exemple :

Commencez par un bref résumé. Traitez en priorité les changements de comportement,
les pertes de données et les cas limites pour lesquels il manque des tests.
Pour chaque problème signalé, indiquez quelle entrée le déclenche et expliquez
le comportement attendu ainsi que le comportement observé. Adoptez le style concis
que notre équipe utilise pour ses revues.

Ces consignes s’appliquent à toutes les revues que vous lancez avec Passer en revue avec Codex, quel que soit le dépôt. Si vous modifiez les consignes pendant une revue, les modifications prendront effet à la revue suivante. Pour les questions propres à une modification, utilisez la discussion de la pull request.

Si vous le souhaitez, sélectionnez Bande dessinée, Visualisation ou PDF pour ajouter une suggestion de consigne demandant à Codex d’expliquer la modification dans ce format. Adaptez le texte si nécessaire, puis sélectionnez Enregistrer ou Lancer la revue.

Partager les commentaires et en assurer le suivi

Examiner une pull request dans une discussion ne publie aucun commentaire et n’entraîne ni son approbation ni sa fusion. Vous choisissez les problèmes signalés que vous souhaitez partager.

Une fois le problème vérifié, demandez à Codex de vous aider à rédiger un commentaire de revue :

Rédigez un commentaire en suivant les consignes de revue de l’équipe dont nous
avons discuté. Décrivez le comportement que nous avons vérifié lorsqu’aucun
ticket ne correspond au filtre, le comportement attendu dans ce cas et le test
qui permettrait de le vérifier. Gardez le commentaire à l’état de brouillon.

Avant de publier le commentaire, vérifiez les fichiers et les lignes qu’il cite. Gardez vos brouillons dans la discussion jusqu’à ce que vous souhaitiez les publier. Si vous publiez un commentaire dans la vue Résumé ou Modifications, il est immédiatement envoyé à la plateforme qui héberge le dépôt, sans attendre que vous sélectionniez Soumettre la revue.

Sélectionnez Soumettre la revue, puis choisissez Commenter, Approuver ou Demander des modifications pour envoyer votre revue à la plateforme qui héberge le dépôt. Vérifiez votre choix et votre commentaire avant l’envoi.

Si vous êtes à l’origine de la pull request, rouvrez-la et demandez à Codex de traiter des commentaires précis. Examinez les modifications obtenues et exécutez les tests pertinents. Avant d’approuver la pull request ou de la fusionner, examinez sa dernière révision, les résultats des vérifications et les commentaires en suspens.

Le plugin Revue de code ne permet pas de modifier les descriptions de pull requests qui contiennent des images en pièce jointe. Pour modifier ces descriptions, ouvrez la pull request dans GitHub.

Poursuivre dans une discussion

Lorsque la vue Résumé affiche la section Fils de discussion, sélectionnez l’un des liens pour reprendre la conversation correspondante. Cette section regroupe vos discussions associées à la pull request.

Dans Codex, sélectionnez Corriger dans la section Vérifications d’une pull request ouverte pour joindre à la discussion les vérifications qui ont échoué. Codex prépare un message sans l’envoyer. Relisez ou ajoutez votre prompt, puis envoyez-le pour demander à Codex de rechercher la cause de l’échec. Examinez les modifications obtenues et relancez les tests pertinents avant de pousser un correctif.

Les informations de diagnostic disponibles dépendent du service qui exécute la vérification. Avec un service tiers d’intégration continue, Codex peut utiliser l’état et la sortie transmis à GitHub.

Dans ChatGPT Work, importez le code à examiner ou donnez-y accès via un plugin installé qui se connecte à la source. Dans votre prompt, précisez la pull request, la branche, le commit, les fichiers et les critères de revue.

Passer en revue les modifications dans l’application

Ouvrez le volet de revue pour comprendre les modifications, commenter des lignes précises et décider quelles modifications indexer, annuler, inclure dans un commit ou pousser.

Pour demander à Codex d’examiner les modifications, saisissez /review dans la zone de saisie. Choisissez Comparer à une branche de base ou Examiner les modifications non commitées. Codex signale les problèmes par ordre de priorité sans modifier votre arbre de travail.

Le volet de revue nécessite un projet situé dans un dépôt Git. Si votre projet n’est pas encore dans un dépôt Git, l’application vous invite à en créer un.

Saisissez /review pour afficher les options de revue prédéfinies de la CLI. Codex lance un agent dédié qui examine le diff sélectionné et signale, par ordre de priorité, les problèmes sur lesquels vous pouvez agir, sans modifier votre arbre de travail.

Saisissez /review dans la zone de saisie de l’extension IDE. Choisissez Comparer à une branche de base ou Examiner les modifications non commitées. Codex signale les problèmes par ordre de priorité sans modifier votre arbre de travail.

La commande /review apparaît uniquement si le projet ouvert se trouve dans un dépôt Git.

Dans votre prompt, précisez la pull request, la branche, le commit ou les fichiers à examiner. Pour examiner des fichiers locaux auxquels aucun plugin installé ne donne accès, importez-les dans la discussion.

Modifications affichées dans le volet de revue

Le volet de revue reflète l’état de votre dépôt Git. Il affiche les modifications apportées par Codex, les vôtres et toutes les autres modifications du dépôt qui n’ont pas encore fait l’objet d’un commit.

Par défaut, le volet de revue affiche les modifications Non indexées. Choisissez Indexées pour consulter l’index Git, Commit pour examiner un commit précis, Branche pour voir le diff par rapport à votre branche de base ou Dernier tour pour voir les modifications du dernier tour de l’assistant.

Examiner plusieurs dépôts

Lorsqu’un projet local comprend plusieurs dossiers rattachés à différents dépôts Git, le volet de revue peut afficher les modifications de chaque dépôt. Ouvrez le sélecteur de dépôt dans l’en-tête du volet pour examiner un autre dépôt et voir les lignes ajoutées ou supprimées sans quitter la revue en cours.

Choisissez Dernier tour pour voir les dernières modifications apportées par l’assistant dans l’ensemble des dépôts rattachés au projet. Dans cette vue, le sélecteur de dépôt affiche Tous les dépôts. Les autres options, comme Non indexées, Indexées et Branche, s’appliquent au dépôt que vous sélectionnez.

Choisissez l’une de ces options de /review :

• Comparer à une branche de base recherche l’ancêtre commun qui sert de base de fusion, puis examine le diff de votre branche par rapport à cette base.
• Examiner les modifications non commitées inclut les fichiers indexés, non indexés et non suivis.
• Examiner un commit passe en revue l’ensemble exact des modifications du commit sélectionné.
• L’option Consignes de revue personnalisées centre la revue sur les critères que vous indiquez.

Choisissez l’une de ces options de /review :

• Comparer à une branche de base compare votre branche actuelle à celle que vous sélectionnez.
• Examiner les modifications non commitées passe en revue les modifications dans votre arbre de travail.

Les problèmes relevés apparaissent dans la discussion sur le web. Demandez des éléments à l’appui, une nouvelle revue plus ciblée ou des fichiers corrigés que ChatGPT préparera pour vous.

Résultats de la revue de code

Les problèmes relevés apparaissent sous forme de commentaires sur les lignes concernées dans le volet de revue.

Par défaut, les revues s’exécutent dans la discussion en cours. Dans Paramètres > Général > Revue de code, choisissez Détachée pour lancer la revue dans une discussion distincte. Consultez les paramètres de développement.

La revue apparaît comme un tour de discussion dans la transcription. Définissez review_model dans config.toml si vous souhaitez utiliser pour les revues un modèle différent de celui de la session en cours.

Par défaut, la revue s’exécute dans la discussion en cours. Attribuez à chatgpt.reviewDelivery la valeur detached si vous souhaitez que /review lance la revue dans une discussion distincte. Consultez la référence des paramètres de l’extension IDE.

Si vous demandez à ChatGPT de préparer des fichiers corrigés, il utilise les outils et les autorisations de l’espace de travail dont dispose la discussion.

Si vous demandez à Codex d’appliquer les correctifs qu’il a identifiés, vos paramètres de bac à sable et d’approbation habituels s’appliquent.

Naviguer dans le volet de revue

• Cliquez sur le nom d’un fichier pour l’ouvrir, en général, dans l’éditeur de votre choix. Vous pouvez choisir l’éditeur par défaut dans les paramètres de développement.
• Cliquez sur l’arrière-plan du nom du fichier pour déplier ou replier le diff.
• Cliquez sur une ligne en maintenant la touche Commande enfoncée pour ouvrir cette ligne dans l’éditeur de votre choix.
• Vous pouvez indexer les modifications qui vous conviennent ou annuler celles que vous souhaitez écarter.

Commenter des lignes du diff

Vous pouvez ajouter vos commentaires directement sur les lignes concernées du diff. C’est souvent le moyen le plus rapide d’orienter Codex vers le bon correctif.

Pour commenter une ligne :

1. Ouvrez le volet de revue.
2. Survolez la ligne à commenter.
3. Sélectionnez le bouton + qui apparaît.
4. Rédigez votre commentaire et envoyez-le.
5. Une fois tous vos commentaires ajoutés, envoyez un message dans la discussion.

Comme les commentaires portent sur des lignes précises, Codex peut y répondre plus précisément qu’à une consigne générale.

Codex interprète ces commentaires comme des consignes de revue. Après les avoir ajoutés, envoyez un message qui précise ce que vous attendez. Par exemple : « Traitez les commentaires ajoutés aux lignes du diff en limitant les modifications au strict nécessaire. »

Indexer des fichiers et annuler des modifications

Le volet de revue propose des actions Git pour ajuster le diff avant de créer un commit.

Vous pouvez indexer, désindexer ou annuler les modifications à plusieurs niveaux :

• Diff entier : utilisez les boutons d’action dans l’en-tête du volet de revue, comme Tout indexer ou Tout annuler.
• Par fichier : indexez, désindexez ou annulez les modifications d’un seul fichier.
• Par bloc : indexez, désindexez ou annulez un seul bloc du diff.

Indexez les modifications que vous souhaitez retenir et annulez celles que vous souhaitez écarter.

Modifications indexées et non indexées

Un même fichier peut contenir à la fois des modifications indexées et des modifications non indexées. Le volet de revue peut alors afficher le fichier dans les deux vues. C’est le fonctionnement normal de Git.