Codex-Workflow-Muster

Codex kann in verschiedene Entwicklungsworkflows integriert werden, vom täglichen Programmieren bis hin zu komplexem Refactoring, und dadurch die Effizienz deutlich steigern.


Täglicher Entwicklungsworkflow

Die tägliche Entwicklung ist das häufigste Workflow-Muster und eignet sich für das Erstellen neuer Funktionen oder kleinerer Änderungen.

Workflow-Schritte

SchritteAktionCodex-Interaktion
1Anforderungen klärenBeschreiben Sie die Funktionalität, die Sie implementieren möchten
2Codex-AnalyseCodex versteht Projektstruktur und Konventionen
3LösungsdiskussionImplementierungsansatz mit Codex bestätigen
4CodegenerierungCodex schreibt Code und ändert Dateien
5ValidierungstestsTests ausführen, um die korrekte Funktionalität zu bestätigen
6Iterative OptimierungCode anhand von Feedback anpassen

Beispiel: Hinzufügen eines neuen API-Endpunkts

Täglicher Entwicklungsprozess

# Schritt 1: Anforderungen beschreiben
"Füge einen GET-Endpunkt unter dem Pfad /api/users hinzu, der die Benutzerliste zurückgibt,
Unterstützt Paginierungsparameter page und limit


# Schritte 2-3: Codex analysiert und bestätigt den Plan
Codex wird die bestehende API-Struktur analysieren und bestätigen:
- Speicherorte der Routendefinitionen
- Datenbankabfragemethoden
- Spezifikationen des Antwortformats

# Schritt 4: Codegenerierung
Codex erstellt automatisch:
- Routendefinitionen
- Datenabfragelogik
- Fehlerbehandlung
- Antwortformatierung

# Schritt 5: Verifikationstests
"Tests ausführen und den neuen Endpunkt prüfen"

# Schritt 6: Iterative Optimierung
"Cache-Unterstützung hinzufügen; Antwortzeit sollte unter 100ms liegen"

Workflow zum Codeverständnis

Wenn Sie Legacy-Code oder unbekannte Projekte verstehen müssen, verwenden Sie diesen Workflow.

Explorativer Workflow

  1. Beginnen Sie am Einstiegspunkt und lassen Sie Codex die Gesamtarchitektur erklären
  2. Tauchen Sie schrittweise in Schlüsselmodule ein, um die Kernlogik zu verstehen
  3. Datenfluss und Aufrufketten nachverfolgen
  4. Wichtige Punkte und Überlegungen zusammenfassen

Legacy-Projekte verstehen

# Gesamtarchitektur
"Analysiere die Gesamtarchitektur dieses Projekts, erkläre die Hauptmodule und ihre Beziehungen"

# Kernmodule
"Erkläre, wie das Modul src/auth funktioniert, einschließlich des Authentifizierungsablaufs und der Berechtigungsprüfungen"

# Datenflussverfolgung
"Verfolge den vollständigen Ablauf von der Anfrage bis zur Antwort nach der Benutzeranmeldung"

# Wichtige Zusammenfassung
"Fasse die zentralen Designmuster dieses Projekts und Bereiche zusammen, die Aufmerksamkeit erfordern"

Schnelle Einarbeitung in neue Projekte

Leitfaden für den Einstieg in neue Projekte

# Projektübersicht
"Was ist dieses Projekt? Was sind seine Hauptfunktionen und sein Technologie-Stack?"

# Entwicklungsleitfaden
"Wie starte ich die lokale Entwicklungsumgebung? Wie führe ich Tests aus?"

# Code-Standards
"Was sind die Code-Standards für dieses Projekt? Welche Konventionen gibt es?"

# Modulnavigation
Welche Dateien müssen geändert werden, um Feature X hinzuzufügen?

Refactoring-Workflow

Refactoring erfordert sorgfältiges Vorgehen; Codex kann dir helfen, die Codestruktur systematisch zu verbessern.

Refactoring-Prinzipien

  • Zuerst die bestehende Codestruktur verstehen
  • In kleinen Schritten refaktorieren, schrittweise verbessern
  • Bei jedem Schritt validieren, um sicherzustellen, dass die Funktionalität unverändert bleibt
  • Testabdeckung beibehalten

Schritte des Refactoring-Workflows

SchritteBeschreibung
Probleme identifizierenCodex analysiert den Code und identifiziert Bereiche, die verbessert werden müssen
Einen Plan entwickelnDen Refactoring-Plan besprechen, die Verbesserungsrichtung bestätigen
Schritt für Schritt ausführenKleine Änderungen vornehmen, nach jeder Modifikation validieren
Testen und verifizierenAlle Tests ausführen, um sicherzustellen, dass die Funktionalität korrekt ist
Aufräumen und optimierenRedundanten Code entfernen, Namensgebung optimieren

Refactoring-Beispiel

# Probleme identifizieren
Analysiere das Modul src/utils, identifiziere Code-Duplikation und unvernünftige Designs

# Einen Plan erstellen
Diskutiere, wie dieses Modul refaktoriert werden kann, während die Abwärtskompatibilität erhalten bleibt

# Schritt für Schritt ausführen
Schritt 1: Gemeinsame Funktionen in utils/common.py extrahieren

# Testen und Überprüfen
Führe alle Tests aus, um zu bestätigen, dass das Refactoring die Funktionalität nicht beeinträchtigt hat

# Mit dem nächsten Schritt fortfahren
Schritt 2: Komplexe Funktionen vereinfachen, indem man sie in kleinere Einheiten aufteilt

Verwende beim Refactoring zuerst den /plan-Modus, um einen Plan zu erstellen, und führe dann Schritt für Schritt aus, um große einmalige Änderungen zu vermeiden.


Bug-Fix-Workflow

Codex kann dir helfen, Bugs schnell zu finden und zu beheben.

Fix-Workflow

SchritteAktion
Problem beschreibenSymptome des Bugs und Auslösebedingungen beschreiben
Informationen bereitstellenFehlermeldungen, Logs und Screenshots teilen
Grundursache findenCodex analysiert und ermittelt die Grundursache
Fix generierenCodex schlägt einen Fix vor
Fix verifizierenTests ausführen, um zu bestätigen, dass die Probleme behoben sind
Erneutes Auftreten verhindernTests hinzufügen, um dieses Szenario abzudecken

Beispiel zur Fehlerbehebung

# Das Problem beschreiben
Benutzer stoßen beim Login gelegentlich auf 500-Fehler, und das Fehlerprotokoll zeigt:
TypeError: Cannot read property 'id' of undefined"


# Informationen bereitstellen
Hier ist der vollständige Fehler-Stack: [Stack-Informationen einfügen]

# Grundursache ermitteln
Nach der Analyse hat Codex das Problem gefunden: Das Benutzerobjekt ist in manchen Fällen null

# Fehlerbehebung generieren
Behebe dieses Problem und stelle sicher, dass es den normalen Login-Ablauf nicht beeinträchtigt

# Behebung überprüfen
Führe alle Login-bezogenen Tests aus

# Wiederholung verhindern
"Füge einen Test hinzu, der das Szenario abdeckt, in dem das Benutzerobjekt null ist"

Screenshot-gestütztes Debugging

Verwende Screenshots, um Codex zu helfen, das Problem zu verstehen:

Bildeingabe

# Screenshot in CLI anhängen
codex -i error-screenshot.png "Erkläre diesen Fehler und behebe ihn"

# Screenshot in IDE einfügen
Füge den Screenshot direkt in die Konversation ein und beschreibe das Problem

Code-Review-Workflow

Codex kann Codeänderungen überprüfen, Probleme erkennen und Verbesserungsvorschläge machen.

Review-Modus

ModeAuslösemethodeAnwendbare Szenarien
Review-ModusIn der App aktivierenNicht committete lokale Änderungen überprüfen
/review-BefehlIn CLI/IDE verwendenÄnderungen in einem angegebenen Bereich überprüfen
GitHub-Integration@codex review in PRPull Request überprüfen

Lokale Überprüfung

Review-Modus

# Review-Modus in der App aktivieren
Klicken Sie auf das Augensymbol in der Symbolleiste

# Oder verwenden Sie es in der CLI
/Review

# Review-Umfang festlegen
/review src/auth/

# Bestimmte Commits überprüfen
/review HEAD~3..HEAD

Review-Fokus anpassen

Review-Fokus festlegen

# Sicherheits-Review
/review auf Sicherheitsprobleme

# Performance-Review
/review auf Performance-Regressionen

# Code-Stil
/review auf Code-Stil-Konsistenz

# Umfassende Überprüfung
/review --detailed

Workflow zum Schreiben von Tests

Codex kann dir helfen, Testcode zu schreiben und zu pflegen.

Testen neuer Features

Tests schreiben

# Tests für das neue Feature schreiben
"Unit-Tests für den GET-Endpunkt von src/api/users.py schreiben,
einschließlich normaler Antworten, leerer Liste, Paginierungsgrenzen und anderer Szenarien"


# Tests überprüfen
"Die neu geschriebenen Tests ausführen"

# Abdeckung ergänzen
"Prüfe die Testabdeckung und ergänze nicht abgedeckte Edge Cases"

Tests reparieren

Fehlgeschlagene Tests beheben

# Fehlgeschlagene Tests analysieren
"Test test_user_login ist fehlgeschlagen; analysiere die Ursache und behebe sie"

# Batch-Fix
"Alle Tests ausführen und fehlgeschlagene Tests beheben"

Workflow zur Dokumentationserstellung

Codex kann beim Generieren und Aktualisieren von Dokumentation helfen.

Dokumentation generieren

Dokumentationserstellung

# API-Dokumentation
"Generiere API-Dokumentation für das Modul src/api, einschließlich Anfrage- und Antwortformate für jeden Endpunkt."

# README-Aktualisierung
"Aktualisiere README.md und füge Beschreibungen und Anwendungsbeispiele für neue Funktionen hinzu."

# Inline-Kommentare
"Füge Kommentare zu komplexen Funktionen hinzu, die die Kernlogik erklären."

Best Practices

Workflow-Auswahl

  • Tägliche Entwicklung: kontinuierliche Interaktion, iterative Verbesserung
  • Refactoring: zuerst planen, dann ausführen, in kleinen Schritten validieren
  • Fehlerbehebung: ausreichende Informationen bereitstellen und die Grundursache überprüfen
  • Review: regelmäßig durchführen, auf Sicherheitsprobleme konzentrieren

Effizienztipps

  • Verwende AGENTS.md, um Projektkonventionen zu definieren und wiederholte Anweisungen zu reduzieren
  • Verwende Skills, um gängige Workflows zu kapseln
  • Worktree verwenden, um verschiedene Aufgaben zu isolieren
  • Konfiguriere eine sinnvolle Approval-Richtlinie

FAQ

F: Wie geht man mit umfangreichem Refactoring um?

Verwende den /plan-Modus, um einen Schritt-für-Schritt-Plan zu erstellen und nach jedem Schritt zu überprüfen.

F: Wie verhindert man, dass Fehler nach der Behebung erneut auftreten?

Füge dedizierte Tests hinzu, um dieses Szenario abzudecken, und ergänze relevante Prüfregeln in AGENTS.md.

F: Wie kann man Codex dabei helfen, Projektkonventionen zu verstehen?

Erstelle eine AGENTS.md-Datei, um den Technologie-Stack des Projekts, Code-Konventionen, Testanforderungen usw. zu definieren.

F: Wie werden Review-Ergebnisse mit dem Team geteilt?

Verwende die GitHub-Integration, um im PR zu reviewen; die Ergebnisse werden automatisch als Kommentare hinzugefügt.

Weitere Erweiterungen