Mit ChatGPT oder Codex kannst du Codeänderungen nachvollziehen, möglichen Problemen nachgehen und Feedback für ein Review vorbereiten.
Pull Requests überprüfen
Das Plugin Code Review zeigt dir die Beschreibung, die geänderten Dateien, die Kommentare und die Checks eines Pull Requests. Damit kannst du möglichen Problemen nachgehen, bevor du den Pull Request genehmigst.
Code Review ist für GitHub allgemein verfügbar. Die Unterstützung für Merge Requests aus GitLab ist in Code Review als Vorschau verfügbar. Wie du Cloud-Reviews aus GitLab mit @codex review auslöst oder Merge Requests automatisch überprüfen lässt, erfährst du in Merge Requests aus GitLab mit Codex überprüfen.
Informationen zu Reviews, die über das Repository ausgelöst werden, findest du im Leitfaden zur GitHub-Integration und im Setup für Umgebungen in Codex Cloud (Legacy).
Code Review ist in der Desktop-App enthalten. In der Liste deiner installierten Plugins kannst du es an die Seitenleiste der App anheften.
Einen Pull Request ansehen
- Öffne Code Review in der Seitenleiste.
- Verbinde dein Konto beim Repository-Anbieter, wenn du dazu aufgefordert wirst. Verwende ein Konto mit Zugriff auf das Repository, das du überprüfen möchtest.
- Wähle in der Seitenleiste einen Pull Request aus oder gib seinen Link in das Suchfeld ein.
- Unter Zusammenfassung findest du die Beschreibung, die Aktivitäten, die Kommentare und die Checks. Öffne Änderungen, um die geänderten Dateien und die Kommentare zusammen mit dem Diff anzusehen.
Reviews finden, bei denen du gefragt bist
In deiner persönlichen Inbox findest du Pull Requests aus verschiedenen Repositorys auf GitHub. Unter Mir zugewiesen findest du Review-Anfragen an dich, unter Meinem Team zugewiesen Anfragen an dein Team und unter Von mir erstellt deine eigenen Änderungen. Prüfe den Review-Status und öffne dann den Pull Request, um dir das Feedback und die Checks anzusehen.
Wenn du später zu einem Review zurückkehren möchtest, wähle das Stecknadelsymbol in der Symbolleiste des Reviews. Der Pull Request erscheint in der Seitenleiste unter Angeheftet.
Geänderte Dateien und zugehörige Pull Requests prüfen
Wähle unter Änderungen bei einer Datei Als angesehen markieren, sobald du sie überprüft hast. Wähle die Option erneut, um die Markierung zu entfernen. Die Markierung gilt für die angezeigte Revision.
Sind Änderungen auf mehrere voneinander abhängige Pull Requests verteilt, kannst du über Stack in der Zusammenfassung einen zugehörigen Pull Request öffnen und seinen Diff, seine Kommentare und seine Checks prüfen. Dieser Abschnitt erscheint, wenn Code Review eine Reihe voneinander abhängiger offener Pull Requests erkennt.
Ein automatisches Cloud-Review lesen
Wenn du den ChatGPT-Konnektor für Codex verwendest, über die erforderlichen Repository-Berechtigungen verfügst und automatische Reviews aktiviert sind, kann Codex einen Pull Request auf GitHub überprüfen, bevor du ihn öffnest. Die Kommentare erscheinen auf GitHub und in Code Review.
Für Cloud-Reviews musst du keine Cloud-Umgebung erstellen oder verwalten. Informationen zu den Verbindungsvoraussetzungen, den Repository-Einstellungen und zu Reviews, die du mit @codex review auslöst, findest du in Codex in GitHub verwenden.
Gleiche die Review-Ergebnisse mit dem Diff ab. Automatische Cloud-Reviews laufen unabhängig von den Reviews, die du im Chat eines Pull Requests startest.
Fragen zur Änderung stellen
Beschreibe im Chat des Pull Requests das erwartete Verhalten und bitte Codex, die Änderung zu erklären oder genauer zu untersuchen.
Wähle Mit Codex überprüfen, um ein Review in einem neuen Chat zu starten. Wenn du den Pull Request neben einem bestehenden Chat geöffnet hast, kannst du dort Fragen zur Änderung stellen.
Stelle Codex über installierte Skills und verbundene Quellen die Review-Richtlinien oder Designdokumente deines Teams zur Verfügung. Bitte Codex, die Änderung zusammenzufassen und die Risiken zu erläutern. Prüfe anschließend den Kontext und die Codestellen, auf die sich Codex bezieht.
Angenommen, ein Pull Request ergänzt ein Issue-Board um die Filter Open und Closed. Du erwartest, dass All als Standardfilter ausgewählt bleibt und das Board eine Ansicht ohne Einträge zeigt, wenn kein Issue zum Filter passt.
Erkläre mir diesen Pull Request Schritt für Schritt. Geh besonders darauf ein,
welcher Filter standardmäßig ausgewählt ist und was passiert, wenn kein Issue
zum Filter passt. All soll der Standardfilter bleiben.Bitte Codex um Belege.
Zeig mir den Codepfad und die Tests für den Fall, dass kein Issue zum Filter passt.
Erkläre, was die Tests abdecken und was wir noch überprüfen müssen.Prüfe anhand des genannten Diffs und der Tests, ob das Verhalten deinen Erwartungen entspricht.
Wähle einen Hinweis aus dem Review aus, um dir die Erläuterung und die betreffenden Zeilen unter Änderungen anzusehen. Gleiche den Hinweis mit dem aktuellen Diff, dem erwarteten Verhalten und den Tests ab, bevor du entscheidest, ob eine Korrektur nötig ist. Ein laufendes Review kannst du im Review-Chat stoppen.
Dein Review anpassen
Wähle das Zahnradsymbol Review-Anweisungen neben Mit Codex überprüfen. Du kannst die Anweisungen auch unter Einstellungen > Code Review bearbeiten.
Gib Codex Kriterien und ein Berichtsformat für deine Reviews vor, wie im folgenden Beispiel.
Beginne mit einer kurzen Zusammenfassung. Achte zuerst auf Verhaltensänderungen,
Datenverlust und fehlende Tests für Grenzfälle. Erkläre bei jedem Problem, welche
Eingabe es auslöst, welches Verhalten zu erwarten ist und was tatsächlich passiert.
Halte dich an den knappen Review-Stil unseres Teams.Diese Anweisungen gelten für alle Reviews, die du über Mit Codex überprüfen startest, unabhängig vom Repository. Änderst du die Anweisungen während eines laufenden Reviews, gelten sie ab dem nächsten Review. Fragen zu einer bestimmten Änderung kannst du im Chat des Pull Requests stellen.
Optional kannst du Comic, Visualisierung oder PDF auswählen. Dadurch wird eine vorgeschlagene Anweisung ergänzt, mit der Codex die Änderung im gewählten Format erklärt. Passe den Text bei Bedarf an und wähle dann Speichern oder Review starten.
Feedback teilen und weiterbearbeiten
Wenn du einen Pull Request im Chat überprüfst, werden dadurch keine Kommentare veröffentlicht. Der Pull Request wird auch nicht genehmigt oder zusammengeführt. Du entscheidest, welche Hinweise du teilst.
Sobald du ein Problem bestätigt hast, kannst du Codex um einen Entwurf für einen Review-Kommentar bitten.
Entwirf einen Kommentar anhand der Review-Richtlinien unseres Teams, die wir
besprochen haben. Beschreibe, welches Verhalten wir für den Fall bestätigt haben,
dass kein Issue zum Filter passt. Erkläre, was stattdessen passieren sollte und
welcher Test das erwartete Verhalten abdecken würde. Lass den Kommentar als Entwurf im Chat.Prüfe vor dem Veröffentlichen, ob der Entwurf auf die richtigen Dateien und Zeilen verweist. Lass Entwürfe im Chat, bis du sie veröffentlichen möchtest. Wenn du einen Kommentar unter Zusammenfassung oder Änderungen veröffentlichst, wird er sofort an den Repository-Anbieter gesendet, ohne auf Review einreichen zu warten.
Wähle unter Review einreichen eine der Optionen Kommentieren, Genehmigen oder Änderungen anfordern, um dein Review an den Repository-Anbieter zu senden. Prüfe vor dem Absenden die ausgewählte Entscheidung und deinen Review-Kommentar.
Wenn du den Pull Request selbst erstellt hast, öffne ihn erneut und bitte Codex, konkrete Rückmeldungen zu bearbeiten. Prüfe die daraus entstandenen Änderungen und führe die relevanten Tests aus. Sieh dir vor dem Genehmigen oder Zusammenführen die neueste Revision, die Checks und die noch offenen Rückmeldungen an.
In Code Review kannst du die Beschreibung eines Pull Requests nicht bearbeiten, wenn die Beschreibung angehängte Bilder enthält. Öffne den Pull Request dafür in GitHub.
Einen Chat fortsetzen
Wenn unter Zusammenfassung der Abschnitt Threads erscheint, wähle einen verknüpften Chat aus, um die Unterhaltung fortzusetzen. Hier findest du deine Chats zum jeweiligen Pull Request.
Wähle in Codex bei einem offenen Pull Request Beheben unter Checks, um fehlgeschlagene Checks an den Chat anzuhängen. Codex bereitet damit eine Nachricht vor, die du selbst versendest. Prüfe deinen Prompt oder füge einen hinzu und sende die Nachricht, damit Codex die Fehler untersucht. Prüfe die daraus entstandenen Änderungen und führe die relevanten Tests erneut aus, bevor du die Korrektur pushst.
Welche Diagnoseinformationen verfügbar sind, hängt vom Anbieter des Checks ab. Bei CI-Systemen von Drittanbietern kann Codex den Status und die Ausgabe verwenden, die das System an GitHub meldet.
Lokale Änderungen überprüfen
Der integrierte Codex-Befehl /review überprüft Änderungen in deinem lokalen Git-Checkout. Mit dem Plugin Code Review überprüfst du Pull Requests. Wähle deinen Client aus, um die passenden Schritte zu sehen.
Lade in ChatGPT Work den Code hoch, den du überprüfen lassen möchtest, oder stelle ihn über ein installiertes Plugin für die betreffende Quelle bereit. Gib in deinem Prompt den Pull Request, den Branch, den Commit, die Dateien und die Review-Kriterien an.
Änderungen in der App überprüfen
Öffne den Review-Bereich, um Änderungen nachzuvollziehen und Feedback zu einzelnen Zeilen zu geben. Dort kannst du entscheiden, welche Änderungen du stagen, verwerfen, committen oder pushen möchtest.
Gib /review in den Editor ein, um Codex mit der Überprüfung zu beauftragen. Wähle Mit einem Basis-Branch vergleichen oder Nicht committete Änderungen überprüfen. Codex meldet die Hinweise nach Priorität geordnet, ohne deinen Arbeitsbaum zu verändern.
Für den Review-Bereich muss dein Projekt in einem Git-Repository liegen. Ist dein Projekt noch kein Git-Repository, fordert dich die App auf, eines zu erstellen.
Gib /review ein, um die Review-Voreinstellungen der CLI zu öffnen. Codex startet einen eigenen Review-Agenten. Er liest den ausgewählten Diff und liefert konkrete Hinweise in der Reihenfolge ihrer Priorität, ohne deinen Arbeitsbaum zu verändern.
Gib /review in den Editor der IDE-Erweiterung ein. Wähle Mit einem Basis-Branch vergleichen oder Nicht committete Änderungen überprüfen. Codex meldet die Hinweise nach Priorität geordnet, ohne deinen Arbeitsbaum zu verändern.
Der Befehl /review erscheint nur, wenn das geöffnete Projekt in einem Git-Repository liegt.
Umfang des Reviews festlegen
Gib im Prompt an, welchen Pull Request, welchen Branch, welchen Commit oder welche Dateien du überprüfen lassen möchtest. Möchtest du lokale Dateien überprüfen lassen, die über kein installiertes Quellen-Plugin verfügbar sind, lade sie in den Chat hoch.
Welche Änderungen angezeigt werden
Der Review-Bereich zeigt den Zustand deines Git-Repositorys. Er umfasst die Änderungen von Codex, deine eigenen Änderungen und alle weiteren Änderungen im Repository, die noch nicht committet wurden.
Standardmäßig zeigt der Review-Bereich unter Nicht gestagt die Änderungen an, die noch nicht im Git-Index liegen. Wähle Gestagt für den Git-Index, Commit für einen bestimmten Commit, Branch für den Diff gegenüber deinem Basis-Branch oder Letzte Antwort für die Änderungen aus dem letzten Antwortschritt des Assistenten.
Mehrere Repositorys überprüfen
Wenn ein lokales Projekt mehrere Ordner umfasst, die zu unterschiedlichen Git-Repositorys gehören, kann der Review-Bereich Änderungen aus jedem dieser Repositorys anzeigen. Öffne die Repository-Auswahl in der Kopfzeile des Reviews, um ein anderes Repository zu prüfen. Du siehst direkt im aktuellen Review-Bereich, welche Zeilen hinzugefügt oder entfernt wurden.
Wähle Letzte Antwort, um die letzten Änderungen des Assistenten in allen eingebundenen Repositorys zu sehen. Die Repository-Auswahl zeigt für diese Ansicht Alle Repositorys an. Andere Ansichten wie Nicht gestagt, Gestagt und Branch beziehen sich auf das ausgewählte Repository.
Wähle für /review eine der folgenden Optionen.
- Mit einem Basis-Branch vergleichen ermittelt die Merge-Basis und überprüft den Diff deines Branches gegenüber dieser Basis.
- Nicht committete Änderungen überprüfen berücksichtigt gestagte und nicht gestagte Änderungen sowie Dateien, die Git noch nicht verfolgt.
- Einen Commit überprüfen prüft genau die Änderungen, die der ausgewählte Commit enthält.
- Mit Eigene Review-Anweisungen legst du fest, auf welche Kriterien sich das Review konzentriert.
Wähle für /review eine der folgenden Optionen.
- Mit einem Basis-Branch vergleichen vergleicht deinen aktuellen Branch mit einem Branch deiner Wahl.
- Nicht committete Änderungen überprüfen prüft die Änderungen in deinem Arbeitsbaum.
Mit Review-Ergebnissen arbeiten
Die Review-Ergebnisse erscheinen im Web-Chat. Du kannst nach Belegen fragen, ein weiteres Review mit engerem Fokus anfordern oder ChatGPT bitten, überarbeitete Dateien vorzubereiten.
Ergebnisse des Code-Reviews
Die Hinweise erscheinen als Inline-Kommentare im Review-Bereich.
Standardmäßig laufen Reviews im aktuellen Chat. Wähle unter Einstellungen > Allgemein > Code Review die Option Separat, um einen eigenen Review-Chat zu starten. Weitere Informationen findest du in den Entwicklungseinstellungen.
Das Review erscheint als eigener Beitrag im Gesprächsverlauf. Lege mit review_model in config.toml fest, welches Modell Reviews verwenden sollen, wenn du dafür ein anderes Modell als für die aktuelle Sitzung nutzen möchtest.
Standardmäßig läuft das Review im aktuellen Chat. Setze chatgpt.reviewDelivery auf detached, wenn /review einen separaten Review-Chat starten soll. Weitere Informationen findest du in der Referenz zu den Einstellungen der IDE-Erweiterung.
Wenn du ChatGPT bittest, überarbeitete Dateien vorzubereiten, gelten weiterhin die für den Chat verfügbaren Tools und Workspace-Berechtigungen.
Wenn du Codex bittest, die gefundenen Probleme zu beheben, gelten deine üblichen Sandbox- und Genehmigungseinstellungen.
Im Review-Bereich navigieren
- Ein Klick auf einen Dateinamen öffnet die Datei normalerweise im Editor deiner Wahl. Den Standardeditor kannst du in den Entwicklungseinstellungen festlegen.
- Ein Klick auf den Hintergrund des Dateinamens klappt den Diff auf oder zu.
- Halte Command gedrückt und klicke auf eine einzelne Zeile, um sie im Editor deiner Wahl zu öffnen.
- Wenn du mit einer Änderung zufrieden bist, kannst du sie stagen oder unerwünschte Änderungen verwerfen.
Feedback mit Inline-Kommentaren geben
Mit Inline-Kommentaren kannst du Feedback direkt zu einzelnen Zeilen im Diff geben. So kannst du Codex oft am schnellsten zeigen, was korrigiert werden soll.
So hinterlässt du einen Inline-Kommentar.
- Öffne den Review-Bereich.
- Bewege den Mauszeiger über die Zeile, die du kommentieren möchtest.
- Wähle die Schaltfläche +, die dort erscheint.
- Schreibe dein Feedback und sende es ab.
- Wenn du alle Kommentare hinterlassen hast, sende eine Nachricht im Chat.
Da sich die Kommentare auf konkrete Zeilen beziehen, kann Codex genauer darauf eingehen als auf eine allgemeine Anweisung.
Codex verwendet Inline-Kommentare als Hinweise für das Review. Schreibe anschließend im Chat, was Codex damit tun soll, etwa „Gehe auf die Inline-Kommentare ein und beschränke die Änderungen auf das Nötigste.“
Dateien stagen und Änderungen verwerfen
Im Review-Bereich stehen dir Git-Aktionen zur Verfügung, mit denen du den Diff vor dem Commit anpassen kannst.
Du kannst Änderungen auf den folgenden Ebenen stagen, aus dem Git-Index nehmen oder verwerfen.
- Gesamter Diff – Verwende die Schaltflächen in der Kopfzeile des Reviews, etwa Alles stagen oder Alles verwerfen.
- Einzelne Datei – Du kannst die Änderungen an einer Datei stagen, aus dem Git-Index nehmen oder verwerfen.
- Einzelner Änderungsblock – Du kannst einen einzelnen Block im Diff stagen, aus dem Git-Index nehmen oder verwerfen.
Stage die Änderungen, die du für den Commit übernehmen möchtest. Verwirf die Änderungen, die du nicht behalten möchtest.
Gestagte und nicht gestagte Änderungen
Eine Datei kann in Git sowohl gestagte als auch nicht gestagte Änderungen enthalten. In diesem Fall kann sie im Review-Bereich in beiden Ansichten erscheinen. Das entspricht dem normalen Verhalten von Git.