Mit Code Review von Codex kannst du Pull Requests auf GitHub zusätzlich auf schwerwiegende Probleme prüfen lassen. Codex prüft den Diff des Pull Requests, beachtet die Vorgaben deines Repositorys und veröffentlicht die Ergebnisse als reguläres Review auf GitHub. Security Review ist als Forschungsvorschau verfügbar und untersucht mögliche Sicherheitsprobleme in einem Pull Request genauer.
Voraussetzungen
Das brauchst du:
- Ein GitHub-Repository, das mit Codex verbunden ist. Wie du die ältere Integration einrichtest, erfährst du in Codex Cloud (Legacy).
- Zugriff auf die Einstellungen für Code Review in Codex.
- Eine
AGENTS.md-Datei, wenn Codex beim Review die Vorgaben deines Repositorys berücksichtigen soll.
Code Review in Codex einrichten
Um automatische Reviews zu konfigurieren, brauchst du ein verbundenes GitHub-Repository und Push- oder Administratorrechte für dessen Einstellungen auf GitHub.
- Verbinde dein GitHub-Repository mit Codex.
- Öffne die Codex-Einstellungen.
- Wähle dein Repository aus. Aktiviere dann Automatische Überprüfung unter Code überprüfen.
Ein Review von Codex anfordern
- Erwähne
@codex reviewin einem Kommentar zum Pull Request. - Warte, bis Codex mit 👀 reagiert und ein Review veröffentlicht.
Codex veröffentlicht das Review direkt im Pull Request, so wie es auch jemand aus deinem Team tun würde. Auf GitHub weist Codex nur auf Probleme der Prioritäten P0 und P1 hin. So konzentrieren sich die Kommentare auf Risiken mit hoher Priorität.
Automatische Reviews aktivieren
Damit Codex deine Pull Requests automatisch überprüft, aktiviere Automatische Überprüfung unter Persönliche Einstellungen in den Codex-Einstellungen. Mit Review-Auslöser legst du fest, wann ein Review startet. Das gilt für Repositorys, in denen Code Review aktiviert ist. Ein Kommentar mit @codex review ist dafür nicht nötig.
Festlegen, was Codex überprüft
Codex sucht in deinem Repository nach AGENTS.md-Dateien und befolgt die jeweils geltenden Review-Regeln. Ergänze einen Abschnitt mit der Überschrift ## Code Review Rules in der Datei, die dem betroffenen Code am nächsten liegt. Mit ###-Überschriften kannst du zusammengehörige Prüfungen bei Bedarf gruppieren.
Ein Dienst zur Auswertung von Experimenten kann zum Beispiel mit folgender Regel verhindern, dass das Verhalten nach der Exposition die Zusammensetzung einer Vergleichsgruppe verändert:
## Code Review Rules
### Kohorten in Experimenten
- Filtere beim Vergleich von Versuchsgruppen nicht nach dem Verhalten nach der Exposition, etwa nach Konversion oder Nutzerbindung.
Bilde die Kohorten anhand der Gruppenzuweisung oder der tatsächlichen Exposition. Weise die Konversion als Ergebnis aus.
Lege Regeln für das gesamte Repository in der Datei AGENTS.md im Stammverzeichnis ab. Regeln für einzelne Dienste gehören in eine Datei im jeweiligen Unterverzeichnis, etwa services/experiment_reporting/AGENTS.md. Für jede geänderte Datei berücksichtigt Codex sowohl die Regeln aus dem Stammverzeichnis als auch die jeweils geltenden spezifischeren Vorgaben. Bei Änderungen, die einen Dienst nicht betreffen, spielen dessen Vorgaben also keine Rolle.
Beginne mit zwei oder drei knappen Regeln für Prüfungen, die dein Team bei Reviews häufig erklären muss. Achte dabei auf Folgendes:
- Konzentriere dich auf Verhalten, das in deinem Repository erhebliche Folgen hat. Beschreibe, auf welche Kompatibilitätsanforderung, Datengrenze oder riskante Nebenwirkung Codex hinweisen soll und warum sie wichtig ist.
- Nenne das sichere Vorgehen oder die Ausnahme. Gib Codex genug Kontext, um ein tatsächliches Problem von erwartetem Verhalten zu unterscheiden.
- Formuliere Regeln mit klarem Geltungsbereich, die langfristig gelten. Beschreibe das gewünschte Ergebnis, statt Funktionsnamen zu nennen, die sich ändern können. Lege die Vorgaben in der Nähe des Codes ab, für den sie gelten.
- Überlasse Routineprüfungen der CI. Formatierung, Linting und andere deterministische Prüfungen gehören nicht in die Review-Regeln.
Öffne einen repräsentativen Pull Request und fordere mit @codex review ein Review an. Passe die Regeln anhand der Ergebnisse und Rückmeldungen an. Grenze Vorgaben ein, die zu irrelevanten Hinweisen führen, oder entferne sie.
Review-Regeln geben Codex Orientierung. Tests, Schutzregeln für Branches und erforderliche Genehmigungen sind weiterhin nötig.
Wenn Codex bei einem einzelnen Review auf etwas Bestimmtes achten soll, gib das im Kommentar zum Pull Request an:
@codex review Achte auf Probleme bei der Datenbankmigration.
Security Review
Mit Security Review kannst du Pull Requests zusätzlich auf Sicherheitsprobleme prüfen lassen. Security Review untersucht Sicherheitsrisiken genauer als Code Review. Dazu analysiert Codex den Diff des Pull Requests, relevante Informationen aus dem Repository sowie konfigurierte Bedrohungsmodelle oder Sicherheitsvorgaben.
Auch Code Review kann bei der allgemeinen Prüfung Sicherheitsprobleme erkennen. Deshalb können sich die Ergebnisse von Code Review und Security Review gelegentlich überschneiden.
Security Review einrichten
Eine ausführliche Anleitung und weitere Konfigurationsmöglichkeiten findest du in Security Review.
- Verbinde dein GitHub-Repository mit Codex.
- Öffne die Codex-Einstellungen.
- Wähle dein Repository aus. Aktiviere unter Auf Sicherheitslücken prüfen die Option Automatische Sicherheitsprüfung. Lege mit Überprüfen fest, wessen Pull Requests geprüft werden. Wähle für Auslöser die Option Bei jedem Code Review, damit Security Review zusammen mit Code Review ausgeführt wird.
Ein Security Review anfordern
Um ein Security Review manuell anzufordern, füge einem Pull Request diesen Kommentar hinzu:
@codex security review
Codex reagiert auf den Kommentar, während die Prüfung läuft, und veröffentlicht anschließend die Ergebnisse direkt im Pull Request. Öffne die zugehörige Codex-Aufgabe und wähle den Tab Sicherheitsbericht, um den vollständigen Bericht zu lesen.
Probleme mit Code Review beheben
Wenn Codex nicht reagiert oder kein Review veröffentlicht:
- Prüfe, ob du Code Review für das Repository in den Codex-Einstellungen aktiviert hast.
- Prüfe, ob der Pull Request zu einem GitHub-Repository gehört, das mit Codex verbunden ist.
- Verwende in einem Kommentar zum Pull Request genau den Auslöser
@codex review. - Prüfe bei automatischen Reviews die Option Automatische Überprüfung sowohl in den Repository-Einstellungen als auch unter Persönliche Einstellungen in den Codex-Einstellungen. Vergewissere dich, dass das Ereignis im Pull Request dem eingestellten Review-Auslöser entspricht.
