Revue de code

Utilisez ChatGPT ou Codex pour examiner les modifications de code avant de les valider ou de les pousser.

Démarrer une revue

Effectuer une revue dans l’application

Ouvrez le volet de revue pour comprendre les modifications, formuler des commentaires propres à certaines lignes et décider des éléments à indexer, rétablir, valider ou pousser.

Pour demander à Codex d’examiner les modifications, saisissez /review dans la zone de rédaction. Choisissez Comparer à une branche de base ou Examiner les modifications non validées. Codex présente les constats par ordre de priorité sans modifier votre arborescence de travail.

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

Choisir le périmètre de la revue

Modifications affichées

Le volet de revue reflète l’état de votre dépôt Git, et pas seulement les éléments modifiés par Codex. Il comprend les modifications effectuées par Codex, celles que vous avez effectuées vous-même et toutes les autres modifications non validées du dépôt.

Par défaut, le volet de revue affiche les modifications Non indexées. Utilisez Indexées pour l’index Git, Commit pour un commit sélectionné, Branche pour la différence avec votre branche de base ou Dernier tour pour le tour le plus récent de l’assistant.

Examiner plusieurs dépôts

Lorsqu’un projet local comprend plusieurs dossiers associé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 de la revue pour inspecter un autre dépôt et voir les lignes ajoutées ou supprimées sans quitter le volet de revue actuel.

Choisissez Dernier tour pour voir les dernières modifications de l’assistant dans tous les dépôts associés. Le sélecteur de dépôt affiche Tous les dépôts dans cette vue. Les autres périmètres de revue, tels que Non indexées, Indexées et Branche, s’appliquent au dépôt que vous sélectionnez.

Exploiter les résultats de la revue

Résultats de la revue de code

Les constats de la revue apparaissent sous forme de commentaires en ligne dans le volet de revue.

Par défaut, les revues s’exécutent dans la discussion actuelle. Sous Paramètres > Général > Revue de code, choisissez Détachée pour démarrer une discussion de revue distincte. Consultez les paramètres développeur.

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

Naviguer dans le volet de revue

• Un clic sur le nom d’un fichier ouvre généralement ce fichier dans l’éditeur de votre choix. Vous pouvez choisir l’éditeur par défaut dans les paramètres développeur.
• Un clic sur l’arrière-plan du nom du fichier développe ou réduit la différence.
• Un clic sur une ligne tout en maintenant la touche Cmd enfoncée ouvre la ligne dans l’éditeur de votre choix.
• Si une modification vous convient, vous pouvez l’indexer ou rétablir les modifications dont vous ne voulez pas.

Commentaires en ligne

Les commentaires en ligne vous permettent d’associer directement des remarques à des lignes précises de la différence. Il s’agit souvent du moyen le plus rapide d’orienter Codex vers le bon correctif.

Pour laisser un commentaire en ligne :

1. Ouvrez le volet de revue.
2. Survolez la ligne que vous souhaitez commenter.
3. Sélectionnez le bouton + qui apparaît.
4. Rédigez votre commentaire et envoyez-le.
5. Lorsque vous avez terminé d’ajouter vos commentaires, envoyez un message dans la discussion.

Comme les commentaires portent sur des lignes précises, Codex peut répondre avec davantage de précision qu’à une instruction générale.

Codex traite les commentaires en ligne comme des indications pour la revue. Après avoir ajouté vos commentaires, envoyez un message de suivi qui explicite votre intention, par exemple : « Traitez les commentaires en ligne et limitez au maximum le périmètre des modifications. »

Revues de pull requests

Lorsque Codex dispose d’un accès GitHub à votre dépôt et que le projet actuel se trouve sur la branche de la pull request, l’application de bureau ChatGPT peut vous aider à traiter les commentaires sur la pull request sans quitter l’application. La barre latérale affiche le contexte de la pull request et les commentaires des relecteurs, tandis que le volet de revue affiche les commentaires à côté de la différence afin que vous puissiez demander à Codex de résoudre les problèmes dans la même discussion.

Installez GitHub CLI (gh) et authentifiez-le avec gh auth login afin que Codex puisse charger le contexte de la pull request, les commentaires de revue et les fichiers modifiés. Si gh est absent ou non authentifié, les détails de la pull request peuvent ne pas apparaître dans la barre latérale ou le volet de revue.

Utilisez ce processus lorsque vous souhaitez regrouper l’intégralité de la boucle de correction au même endroit :

1. Ouvrez le volet de revue sur la branche de la pull request.
2. Examinez le contexte de la pull request, les commentaires et les fichiers modifiés.
3. Demandez à Codex de corriger les commentaires précis que vous souhaitez traiter.
4. Examinez la différence obtenue dans le volet de revue.
5. Indexez, validez et poussez les modifications vers la branche de la pull request lorsque vous êtes prêt.

Pour les revues déclenchées depuis GitHub, consultez Utiliser Codex dans GitHub.

Indexer et rétablir des fichiers

Le volet de revue comprend des actions Git qui vous permettent d’ajuster la différence avant de la valider.

Vous pouvez indexer, désindexer ou rétablir des modifications à ces niveaux :

• Intégralité de la différence : utilisez les boutons d’action de l’en-tête de la revue, tels que Tout indexer ou Tout rétablir.
• Par fichier : indexez, désindexez ou rétablissez un fichier individuel.
• Par fragment : indexez, désindexez ou rétablissez un seul fragment.

Utilisez l’indexation lorsque vous souhaitez accepter une partie du travail, et le rétablissement lorsque vous souhaitez l’abandonner.

États indexé et non indexé

Git peut représenter simultanément des modifications indexées et non indexées dans un même fichier. Dans ce cas, le volet peut afficher le même fichier dans les deux vues. Il s’agit du comportement normal de Git.