Code-Review

Verwenden Sie ChatGPT oder Codex, um Codeänderungen zu prüfen, bevor Sie sie committen oder pushen.

Review starten

Laden Sie in ChatGPT Work den zu prüfenden Code hoch oder stellen Sie ihn über ein installiertes Quellcode-Plugin bereit. Geben Sie in Ihrem Prompt den Pull Request, Branch, Commit, die Dateien und die Prüfkriterien an.

Review in der App

Öffnen Sie den Review-Bereich, um die Änderungen nachzuvollziehen, zeilenspezifisches Feedback zu geben und zu entscheiden, was Sie stagen, zurücksetzen, committen oder pushen möchten.

Um Codex mit der Prüfung der Änderungen zu beauftragen, geben Sie /review in den Composer ein. Wählen Sie Review anhand eines Basis-Branches oder Nicht committete Änderungen überprüfen. Codex meldet priorisierte Befunde, ohne Ihren Arbeitsbaum zu verändern.

Der Review-Bereich erfordert ein Projekt in einem Git-Repository. Wenn Ihr Projekt noch kein Git-Repository ist, fordert die App Sie auf, eines zu erstellen.

Geben Sie /review ein, um die CLI-Prüfvoreinstellungen zu öffnen. Codex startet einen dedizierten Prüfer, der den ausgewählten Diff liest und priorisierte, umsetzbare Befunde meldet, ohne Ihren Arbeitsbaum zu verändern.

Geben Sie /review in das Eingabefeld der IDE-Erweiterung ein. Wählen Sie Mit einem Basis-Branch vergleichen oder Nicht committete Änderungen prüfen. Codex meldet priorisierte Befunde, ohne Ihren Arbeitsbaum zu verändern.

Der Befehl /review wird nur angezeigt, wenn sich das geöffnete Projekt in einem Git-Repository befindet.

Review-Umfang auswählen

Nennen Sie in Ihrem Prompt den zu prüfenden Pull Request, Branch, Commit oder die Dateien. Um lokale Dateien zu prüfen, die nicht über ein installiertes Quellcode-Plugin verfügbar sind, laden Sie sie in den Chat hoch.

Welche Änderungen angezeigt werden

Der Review-Bereich bildet den Status Ihres Git-Repositorys ab, nicht nur die Änderungen, die Codex vorgenommen hat. Er enthält Änderungen von Codex, Ihre eigenen Änderungen und alle anderen nicht committeten Änderungen im Repository.

Standardmäßig zeigt der Review-Bereich Nicht gestagte Änderungen. Verwenden Sie Gestagt für den Git-Index, Commit für einen ausgewählten Commit, Branch für den Diff gegenüber Ihrem Basis-Branch oder Letzter Turn für den jüngsten Assistenten-Turn.

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 Repository anzeigen. Öffnen Sie die Repository-Auswahl in der Kopfzeile des Review-Bereichs, um ein anderes Repository zu prüfen und die hinzugefügten oder entfernten Zeilen anzuzeigen, ohne den aktuellen Review-Bereich zu verlassen.

Wählen Sie Letzter Turn, um die neuesten Änderungen des Assistenten in allen verknüpften Repositorys anzuzeigen. Die Repository-Auswahl zeigt für diese Ansicht Alle Repositorys an. Andere Review-Umfänge wie Nicht gestagt, Gestagt und Branch gelten für das ausgewählte Repository.

Wählen Sie einen der folgenden /review-Prüfbereiche aus:

• Mit einem Basis-Branch vergleichen ermittelt die Merge-Basis und prüft den Diff Ihres Branches.
• Nicht committete Änderungen prüfen umfasst vorgemerkte, nicht vorgemerkte und nicht verfolgte Dateien.
• Einen Commit prüfen prüft den exakten Änderungssatz eines ausgewählten Commits.
• Benutzerdefinierte Prüfanweisungen richtet die Prüfung auf die von Ihnen angegebenen Kriterien aus.

Wählen Sie einen der folgenden /review-Prüfbereiche aus:

• Mit einem Basis-Branch vergleichen vergleicht Ihren aktuellen Branch mit einem von Ihnen ausgewählten Branch.
• Nicht committete Änderungen prüfen prüft die Änderungen in Ihrem Arbeitsbaum.

Mit Review-Ergebnissen arbeiten

Die Prüfbefunde werden im Webchat angezeigt. Bitten Sie um Belege, fordern Sie eine enger gefasste Folgeprüfung an oder bitten Sie ChatGPT, überarbeitete Dateien vorzubereiten.

Ergebnisse des Code-Reviews

Review-Befunde erscheinen als Inline-Kommentare im Review-Bereich.

Prüfungen werden standardmäßig im aktuellen Chat ausgeführt. Wählen Sie unter Einstellungen > Allgemein > Code-Review die Option Separat, um einen separaten Prüfchat zu starten. Weitere Informationen finden Sie in den Entwicklereinstellungen.

Die Prüfung wird als Beitrag im Transkript angezeigt. Legen Sie review_model in config.toml fest, wenn Prüfungen ein anderes Modell als die aktuelle Sitzung verwenden sollen.

Standardmäßig wird die Prüfung im aktuellen Chat ausgeführt. Legen Sie chatgpt.reviewDelivery auf detached fest, wenn /review einen separaten Prüfchat starten soll. Weitere Informationen finden Sie in der Referenz zu den Einstellungen der IDE-Erweiterung.

Wenn Sie ChatGPT bitten, überarbeitete Dateien vorzubereiten, gelten weiterhin die für den Chat verfügbaren Tools und Arbeitsbereichsberechtigungen.

Wenn Sie Codex bitten, die gefundenen Fehlerbehebungen anzuwenden, gelten Ihre normalen Sandbox- und Genehmigungseinstellungen.

Im Review-Bereich navigieren

• Durch Klicken auf einen Dateinamen wird diese Datei normalerweise in Ihrem ausgewählten Editor geöffnet. Sie können den Standardeditor in den Entwicklereinstellungen auswählen.
• Durch Klicken auf den Hintergrund des Dateinamens wird der Diff ein- oder ausgeklappt.
• Wenn Sie bei gedrückter Cmd-Taste auf eine einzelne Zeile klicken, wird diese in Ihrem ausgewählten Editor geöffnet.
• Wenn Sie mit einer Änderung zufrieden sind, können Sie sie stagen oder unerwünschte Änderungen zurücksetzen.

Inline-Kommentare für Feedback

Mit Inline-Kommentaren können Sie Feedback direkt an bestimmte Zeilen im Diff anheften. Dies ist häufig der schnellste Weg, Codex zur richtigen Fehlerbehebung zu führen.

So hinterlassen Sie einen Inline-Kommentar:

1. Öffnen Sie den Review-Bereich.
2. Bewegen Sie den Mauszeiger über die Zeile, die Sie kommentieren möchten.
3. Wählen Sie die eingeblendete Schaltfläche + aus.
4. Schreiben Sie Ihr Feedback und senden Sie es ab.
5. Nachdem Sie Ihr Feedback vollständig hinterlassen haben, senden Sie eine Nachricht an den Chat.

Da die Kommentare zeilenspezifisch sind, kann Codex präziser darauf reagieren als auf eine allgemeine Anweisung.

Codex behandelt Inline-Kommentare als Review-Anleitung. Senden Sie nach dem Hinterlassen der Kommentare eine Folgenachricht, die Ihre Absicht ausdrücklich beschreibt, beispielsweise: „Bearbeiten Sie die Inline-Kommentare und halten Sie den Umfang minimal.“

Pull-Request-Reviews

Wenn Codex GitHub-Zugriff auf Ihr Repository hat und sich das aktuelle Projekt auf dem Pull-Request-Branch befindet, kann die ChatGPT-Desktop-App Sie dabei unterstützen, Pull-Request-Feedback zu bearbeiten, ohne die App zu verlassen. Die Seitenleiste zeigt den Pull-Request-Kontext und das Feedback der Reviewer an, während der Review-Bereich Kommentare neben dem Diff darstellt, sodass Sie Codex im selben Chat mit der Bearbeitung von Problemen beauftragen können.

Installieren Sie die GitHub CLI (gh) und authentifizieren Sie sie mit gh auth login, damit Codex den Pull-Request-Kontext, Review-Kommentare und geänderte Dateien laden kann. Wenn gh fehlt oder nicht authentifiziert ist, werden Pull-Request-Details möglicherweise nicht in der Seitenleiste oder im Review-Bereich angezeigt.

Verwenden Sie diesen Ablauf, wenn Sie die gesamte Fehlerbehebung an einem Ort durchführen möchten:

1. Öffnen Sie den Review-Bereich auf dem Pull-Request-Branch.
2. Prüfen Sie den Pull-Request-Kontext, die Kommentare und die geänderten Dateien.
3. Bitten Sie Codex, die konkreten Kommentare zu bearbeiten, die Sie berücksichtigt haben möchten.
4. Prüfen Sie den resultierenden Diff im Review-Bereich.
5. Stagen, committen und pushen Sie die Änderungen auf den Pull-Request-Branch, sobald Sie bereit sind.

Informationen zu durch GitHub ausgelösten Reviews finden Sie unter Codex in GitHub verwenden.

Dateien stagen und zurücksetzen

Der Review-Bereich enthält Git-Aktionen, mit denen Sie den Diff vor dem Committen gestalten können.

Sie können Änderungen auf den folgenden Ebenen stagen, aus dem Staging entfernen oder zurücksetzen:

• Gesamter Diff: Verwenden Sie die Aktionsschaltflächen in der Kopfzeile des Review-Bereichs, etwa Alle stagen oder Alle zurücksetzen.
• Pro Datei: Stagen Sie eine einzelne Datei, entfernen Sie sie aus dem Staging oder setzen Sie sie zurück.
• Pro Hunk: Stagen Sie einen einzelnen Hunk, entfernen Sie ihn aus dem Staging oder setzen Sie ihn zurück.

Verwenden Sie das Staging, wenn Sie einen Teil der Arbeit übernehmen möchten, und das Zurücksetzen, wenn Sie ihn verwerfen möchten.

Gestagte und nicht gestagte Zustände

Git kann in derselben Datei sowohl gestagte als auch nicht gestagte Änderungen darstellen. In diesem Fall kann der Bereich dieselbe Datei in beiden Ansichten anzeigen. Das ist normales Git-Verhalten.