Revue de code

Revues de pull requests

Le plugin Code Review 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 de l’approuver.

La revue de code GitHub est disponible pour tous. La prise en charge des merge requests GitLab dans Code Review est en préversion. Pour déclencher des revues dans le cloud depuis GitLab avec @codex review ou des revues automatiques de merge requests, consultez Examiner les merge requests GitLab avec Codex.

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

L’application de bureau inclut Code Review. Vous pouvez l’épingler dans la barre latérale de l’application depuis vos plugins installés.

Consulter une pull request

1. Ouvrez Code Review depuis la barre latérale.
2. Connectez votre compte de plateforme de code lorsque vous y êtes invité. Utilisez un compte ayant 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 Résumé pour accéder à la description, à l’activité, aux commentaires et aux vérifications. Ouvrez Modifications pour examiner les fichiers modifiés et les commentaires à côté du diff.

Trouver les revues qui nécessitent votre attention

Utilisez votre boîte de réception personnelle pour retrouver les pull requests GitHub de différents dépôts. Choisissez Attribuées à moi pour les revues qui vous sont demandées, Attribuées à mon équipe pour les demandes adressé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 examiner les retours et les vérifications.

Pour revenir à 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 consulté sur un fichier après l’avoir examiné. Sélectionnez à nouveau cette commande pour retirer le marqueur. Les marqueurs de consultation s’appliquent à la révision affichée.

Pour les modifications réparties entre des pull requests interdépendantes, utilisez Pile dans Résumé pour ouvrir une pull request associée et examiner son diff, ses commentaires et ses vérifications. Cette section apparaît lorsque Code Review détecte une pile de pull requests ouvertes.

Consulter une revue automatique dans le cloud

Avec le connecteur ChatGPT Codex, les autorisations requises sur le dépôt et les revues automatiques activées, Codex peut examiner une pull request GitHub avant que vous ne l’ouvriez. Les commentaires apparaissent sur GitHub et dans Code Review.

La revue dans le cloud ne nécessite pas 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 les revues déclenchées avec @codex review, consultez Utiliser Codex dans GitHub.

Confrontez les constats de la revue au diff. Les revues automatiques dans le cloud sont distinctes des revues que vous lancez dans la conversation de la pull request.

Poser des questions sur la modification

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

Sélectionnez Examiner avec Codex pour lancer une revue dans une nouvelle conversation. Si vous consultez la pull request à côté d’une conversation existante, utilisez celle-ci pour poser des questions sur la modification.

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

Par exemple, une pull request ajoute les filtres Ouverts et Fermés à un tableau de tickets. Vous souhaitez que Tous reste le filtre par défaut et qu’un état vide s’affiche lorsqu’aucun ticket ne correspond :

Walk me through this pull request. Focus on the default filter and what
happens when there are no matching issues. All should remain the default.

Demandez des éléments à l’appui :

Show me the code path and tests for the no-matches case. Explain what is
covered and what still needs verification.

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

Sélectionnez un constat pour consulter son explication et les lignes concernées dans Modifications. Confrontez-le au dernier diff, au comportement attendu et aux tests avant de décider qu’une correction est nécessaire. Utilisez la conversation de revue pour arrêter une revue en cours.

Personnaliser votre revue

Sélectionnez l’icône d’engrenage Instructions de revue à côté de Examiner avec Codex. Vous pouvez aussi modifier ces instructions dans Paramètres > Code Review.

Donnez à Codex des critères et un format de compte rendu applicables à l’ensemble de vos revues, par exemple :

Start with a short summary. Prioritize behavior changes, data loss, and
missing edge-case tests. For each finding, explain the triggering input,
expected behavior, and actual behavior. Use our team's concise review style.

Ces instructions s’appliquent aux revues que vous lancez avec Examiner avec Codex dans tous les dépôts. Les modifications apportées pendant une revue en cours s’appliquent à la revue suivante. Utilisez la conversation de la pull request pour les questions propres à une modification.

Vous pouvez sélectionner Bande dessinée, Visualisation ou PDF pour ajouter une suggestion d’instruction visant à expliquer la modification dans ce format. Adaptez le texte si nécessaire, puis sélectionnez Enregistrer ou Lancer la revue.

Partager vos retours et assurer le suivi

Examiner une pull request dans une conversation ne publie aucun commentaire, ne l’approuve pas et ne la fusionne pas. Vous choisissez les constats à partager.

Après avoir vérifié un problème potentiel, demandez à Codex de vous aider à préparer un commentaire de revue :

Using the team review guidelines we discussed, draft a comment describing
the no-matches behavior we verified, what should happen instead, and the test
that would cover it. Keep the comment as a draft.

Vérifiez les références aux fichiers et aux lignes du brouillon avant de le publier. Gardez les brouillons dans la conversation jusqu’à ce que vous soyez prêt : publier dans Résumé ou Modifications envoie immédiatement le commentaire au fournisseur source, sans attendre Soumettre la revue.

Utilisez Soumettre la revue pour choisir Commenter, Approuver ou Demander des modifications et envoyer votre revue au fournisseur source. Vérifiez la décision sélectionnée et le commentaire de revue avant de soumettre.

Si vous êtes l’auteur de la pull request, revenez-y et demandez à Codex de traiter des retours précis. Examinez les modifications obtenues et exécutez les tests pertinents. Avant d’approuver ou de fusionner, vérifiez la dernière révision, les vérifications et les retours encore en suspens.

La modification des descriptions de pull requests contenant des images jointes n’est pas prise en charge dans Code Review. Ouvrez la pull request dans GitHub pour modifier ces descriptions.

Continuer dans une conversation

Lorsque Résumé affiche Fils de discussion, sélectionnez une conversation liée pour y revenir. Il s’agit de vos conversations associées à la pull request.

Dans Codex, sélectionnez Corriger dans Vérifications sur une pull request ouverte pour joindre les vérifications en échec à la conversation. Cette action prépare un message sans l’envoyer. Relisez ou ajoutez votre prompt, puis envoyez-le pour demander à Codex d’analyser le problème. Examinez les modifications obtenues et relancez les tests pertinents avant de pousser une correction.

Les diagnostics disponibles dépendent du fournisseur de vérifications. Pour une CI tierce, Codex peut utiliser le statut et la sortie transmis à GitHub.

Dans ChatGPT Work, importez le code que vous souhaitez faire examiner ou rendez-le accessible au moyen d’un plugin source installé. Dans votre prompt, indiquez la pull request, la branche, le commit, les fichiers et les critères de révision.

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 worktree.

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.

Saisissez /review pour ouvrir les préréglages de révision de la CLI. Codex lance un réviseur dédié qui lit le diff sélectionné et présente des constats hiérarchisés et exploitables sans modifier votre worktree.

Saisissez /review dans la zone de rédaction de l’extension IDE. Choisissez Review against a base branch ou Review uncommitted changes. Codex présente des constats hiérarchisés sans modifier votre worktree.

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

Dans votre prompt, indiquez la pull request, la branche, le commit ou les fichiers à examiner. Pour examiner des fichiers locaux qui ne sont pas accessibles au moyen d’un plugin source installé, importez-les dans la conversation.

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.

Choisissez l’une de ces portées /review :

• Review against a base branch trouve la base de fusion et examine le diff de votre branche.
• Review uncommitted changes inclut les fichiers indexés, non indexés et non suivis.
• Review a commit examine l’ensemble exact des modifications d’un commit sélectionné.
• Custom review instructions concentre la révision sur les critères que vous fournissez.

Choisissez l’une de ces portées /review :

• Review against a base branch compare votre branche actuelle à une branche que vous sélectionnez.
• Review uncommitted changes examine les modifications de votre worktree.

Les constats de la révision apparaissent dans la conversation web. Demandez des preuves, sollicitez une révision de suivi plus ciblée ou demandez à ChatGPT de préparer des fichiers corrigés.

Résultats de la revue de code

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

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

La révision apparaît comme un tour dans la transcription. Définissez review_model dans config.toml si vous souhaitez que les révisions utilisent un modèle différent de celui de la session actuelle.

Par défaut, la révision s’exécute dans la conversation actuelle. Définissez chatgpt.reviewDelivery sur detached si vous souhaitez que /review lance une conversation de révision distincte. Consultez la référence des paramètres de l’extension IDE.

Si vous demandez à ChatGPT de préparer des fichiers corrigés, les outils et les autorisations de l’espace de travail disponibles dans la conversation continuent de s’appliquer.

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

• Cliquer sur le nom d’un fichier l’ouvre généralement dans l’éditeur de votre choix. Vous pouvez choisir l’éditeur par défaut dans les paramètres de développement.
• Cliquer sur l’arrière-plan du nom du fichier développe ou réduit le diff.
• Cliquer sur une ligne en maintenant la touche Commande enfoncée ouvre cette ligne dans l’éditeur de votre choix.
• Si une modification vous convient, vous pouvez l’indexer ou annuler les modifications que vous ne souhaitez pas conserver.

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. »

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.