GitHub-Pull-Requests mit Codex überprüfen

Nutzen Sie Codex Code Review, um für GitHub-Pull-Requests einen weiteren aussagekräftigen Review-Durchlauf zu erhalten. Codex prüft den Pull-Request-Diff, befolgt die Vorgaben Ihres Repositorys und veröffentlicht ein standardmäßiges GitHub-Code-Review, das sich auf schwerwiegende Probleme konzentriert. Security Review ist als Research Preview verfügbar und bietet eine eingehendere Prüfung potenzieller Sicherheitsprobleme in einem Pull Request.

Video ansehen: Einführung in Codex Code Review

Bevor Sie beginnen

Stellen Sie sicher, dass Folgendes vorhanden ist:

• Codex cloud ist für das Repository eingerichtet, das Sie überprüfen möchten.
• Sie haben Zugriff auf die Einstellungen für Codex-Code-Reviews.
• Eine AGENTS.md-Datei, wenn Codex Repository-spezifische Review-Richtlinien befolgen soll.

Codex-Code-Reviews einrichten

Zum Konfigurieren automatischer Reviews benötigen Sie ein verbundenes GitHub-Repository und GitHub-Push- oder Administratorberechtigungen für dessen Einstellungen.

1. Richten Sie Codex cloud ein.
2. Öffnen Sie die Codex-Einstellungen.
3. Aktivieren Sie Code review für Ihr Repository.

Ein Codex-Review anfordern

1. Erwähnen Sie in einem Pull-Request-Kommentar @codex review.
2. Warten Sie, bis Codex reagiert (👀) und ein Review veröffentlicht.

Codex veröffentlicht ein Review für den Pull Request, genau wie ein Teammitglied. In GitHub kennzeichnet Codex nur Probleme der Prioritätsstufen P0 und P1, damit sich die Kommentare auf Risiken mit hoher Priorität konzentrieren.

Automatische Reviews aktivieren

Wenn Codex jeden Pull-Request automatisch überprüfen soll, aktivieren Sie Automatic reviews in den Codex-Einstellungen. Codex veröffentlicht ein Review, sobald jemand einen neuen PR zur Überprüfung öffnet, ohne dass dafür ein @codex review-Kommentar erforderlich ist.

Anpassen, was Codex überprüft

Codex durchsucht Ihr Repository nach AGENTS.md-Dateien und befolgt die jeweils geltenden Code-Review-Regeln. Fügen Sie der Datei, die dem von den Regeln betroffenen Code am nächsten liegt, einen Abschnitt ## Code Review Rules hinzu. Verwenden Sie bei Bedarf ###-Überschriften, um zusammengehörige Prüfungen zu gruppieren.

Beispielsweise kann ein Dienst für die Berichterstellung zu Experimenten verhindern, dass das Verhalten nach einer Exposition eine Vergleichskohorte verändert:

## Code Review Rules

### Experiment cohorts

- Do not filter treatment comparisons on post-exposure behavior, including conversion or retention.
  Safe path: build cohorts from assignment or exposure; report conversion as an outcome.

Legen Sie Repository-weite Regeln in der AGENTS.md im Stammverzeichnis und dienstspezifische Regeln in einer verschachtelten Datei wie services/experiment_reporting/AGENTS.md ab. Codex wendet für jede geänderte Datei die dafür geltenden Richtlinien aus dem Stammverzeichnis sowie die spezifischeren Richtlinien an, sodass bei nicht zusammenhängenden Änderungen kein dienstspezifischer Kontext berücksichtigt werden muss.

Beginnen Sie mit zwei oder drei prägnanten Regeln, die Prüfungen abbilden, welche Reviewer häufig erläutern. Nützliche Regeln:

• Konzentrieren Sie sich auf folgenreiches, Repository-spezifisches Verhalten. Beschreiben Sie die Kompatibilitätsanforderung, Datengrenze oder unsichere Nebenwirkung, die gekennzeichnet werden soll, und warum sie relevant ist.
• Nennen Sie den sicheren Weg oder die Ausnahme. Geben Sie Codex genügend Kontext, um ein tatsächliches Problem vom erwarteten Verhalten zu unterscheiden.
• Halten Sie Regeln klar abgegrenzt und dauerhaft gültig. Bevorzugen Sie Ergebnisse gegenüber Funktionsnamen, die sich ändern können, und platzieren Sie Richtlinien in der Nähe des Codes, für den sie gelten.
• Überlassen Sie mechanische Prüfungen der CI. Nehmen Sie Formatierungs-, Lint- und andere deterministische Prüfungen nicht in die Review-Regeln auf.

Öffnen Sie einen repräsentativen Pull-Request und fordern Sie mit @codex review ein Review an. Verfeinern Sie die Regeln anhand der angezeigten Ergebnisse und Rückmeldungen und grenzen Sie Richtlinien, die unnötige Meldungen erzeugen, enger ein oder entfernen Sie sie.

Code-Review-Regeln dienen Codex als Leitfaden; sie ersetzen weder Tests noch Branch-Schutzregeln oder erforderliche Genehmigungen.

Wenn Sie den Fokus einmalig festlegen möchten, fügen Sie ihn Ihrem Pull-Request-Kommentar hinzu:

@codex review for issues in the database migration

Security Review

Security Review ist ein zusätzliches Review für Kunden, die Sicherheitsproblemen in Pull Requests besondere Aufmerksamkeit widmen möchten. Es untersucht sicherheitsspezifische Risiken eingehender als Code Review, indem es den Pull-Request-Diff, unterstützenden Repository-Kontext sowie konfigurierte Bedrohungsmodelle oder Sicherheitsrichtlinien analysiert.

Code Review kann im Rahmen seines allgemeinen Reviews ebenfalls sicherheitsrelevante Probleme erkennen. Daher können sich die Ergebnisse von Code Review und Security Review gelegentlich überschneiden.

Security Review einrichten

Ausführlichere Einrichtungsanweisungen und Konfigurationsoptionen finden Sie unter Security Review.

1. Richten Sie Codex cloud ein.
2. Öffnen Sie die Codex settings.
3. Wählen Sie unter Repository preferences aus, welche Pull Requests ein Security Review erhalten und wann es ausgeführt wird. Wählen Sie Whenever code review runs, um es zusammen mit Code Review auszuführen.

Ein Security Review anfordern

Um ein Security Review manuell anzufordern, fügen Sie einem Pull Request diesen Kommentar hinzu:

@codex security review

Codex reagiert, während das Review ausgeführt wird, und veröffentlicht die Sicherheitsergebnisse anschließend direkt im Pull Request. Öffnen Sie die zugehörige Codex-Aufgabe und wählen Sie die Registerkarte Security Report, um den vollständigen Bericht anzuzeigen.

Auf Review-Ergebnisse reagieren

Nachdem Codex ein Review veröffentlicht hat, können Sie Codex bitten, Probleme im selben Pull-Request zu beheben, indem Sie einen weiteren Kommentar hinterlassen:

@codex fix the P1 issue

Codex startet einen Cloud-Chat mit dem Pull-Request als Kontext und kann eine Korrektur zurück in den Branch pushen, sofern die erforderliche Berechtigung vorliegt.

Codex weitere Aufgaben geben

Wenn Sie @codex in einem Kommentar mit einem anderen Inhalt als review erwähnen, startet Codex einen Cloud-Chat, der Ihren Pull-Request als Kontext verwendet.

@codex fix the CI failures

Fehlerbehebung bei Code-Reviews

Wenn Codex nicht reagiert oder kein Review veröffentlicht:

• Vergewissern Sie sich, dass Sie Code review für das Repository in den Codex-Einstellungen aktiviert haben.
• Vergewissern Sie sich, dass der Pull-Request zu einem Repository gehört, für das Codex cloud eingerichtet ist.
• Verwenden Sie in einem Pull-Request-Kommentar exakt den Auslöser @codex review.
• Prüfen Sie bei automatischen Reviews, ob Sie Automatic reviews aktiviert haben und ob das Pull-Request-Ereignis den Einstellungen Ihres Review-Auslösers entspricht.