Modèles de flux de travail Codex
Codex peut être intégré dans divers flux de travail de développement, du codage quotidien à la refactorisation complexe, ce qui améliore considérablement l'efficacité.
Flux de travail de développement quotidien
Le développement quotidien est le modèle de flux de travail le plus courant, adapté à la création de nouvelles fonctionnalités ou à des modifications à petite échelle.
Étapes du flux de travail
| Étapes | Opération | Interaction avec Codex |
|---|---|---|
| 1 | Clarifier les exigences | Décrivez la fonctionnalité que vous souhaitez implémenter. |
| 2 | Analyse de Codex | Codex comprend la structure et les conventions du projet |
| 3 | Discussion de la solution | Confirmer l'approche d'implémentation avec Codex |
| 4 | Génération de code | Codex écrit du code et modifie des fichiers |
| 5 | Tests de validation | Exécuter les tests pour confirmer que la fonctionnalité est correcte |
| 6 | Optimisation itérative | Ajuster le code en fonction des retours |
Exemple : Ajout d'un nouveau point de terminaison d'API
Processus de développement quotidien
# Étape 1 : Décrire les exigences
"Ajouter un point de terminaison GET au chemin /api/users qui renvoie la liste des utilisateurs,
Prend en charge les paramètres de pagination page et limit
# Étapes 2-3 : Codex analyse et confirme le plan
Codex analysera la structure existante de l'API et confirmera :
- Emplacements de définition des routes
- Méthodes d'interrogation de la base de données
- Spécifications du format de réponse
# Étape 4 : Génération de code
Codex crée automatiquement :
- Définitions de routes
- Logique d'interrogation des données
- Gestion des erreurs
- Formatage des réponses
# Étape 5 : Tests de vérification
"Exécutez les tests et vérifiez le nouvel endpoint"
# Étape 6 : Optimisation itérative
"Ajouter la prise en charge du cache ; le temps de réponse doit être inférieur à 100ms"
"Ajouter un point de terminaison GET au chemin /api/users qui renvoie la liste des utilisateurs,
Prend en charge les paramètres de pagination page et limit
# Étapes 2-3 : Codex analyse et confirme le plan
Codex analysera la structure existante de l'API et confirmera :
- Emplacements de définition des routes
- Méthodes d'interrogation de la base de données
- Spécifications du format de réponse
# Étape 4 : Génération de code
Codex crée automatiquement :
- Définitions de routes
- Logique d'interrogation des données
- Gestion des erreurs
- Formatage des réponses
# Étape 5 : Tests de vérification
"Exécutez les tests et vérifiez le nouvel endpoint"
# Étape 6 : Optimisation itérative
"Ajouter la prise en charge du cache ; le temps de réponse doit être inférieur à 100ms"
Workflow de compréhension du code
Lorsque vous devez comprendre du code hérité ou des projets qui ne vous sont pas familiers, utilisez ce workflow.
Workflow exploratoire
- Partez du point d'entrée et laissez Codex expliquer l'architecture globale
- Plongez progressivement dans les modules clés pour comprendre la logique centrale
- Tracez le flux de données et les chaînes d'appels
- Résumez les points clés et les considérations
Comprendre les projets hérités
# Architecture globale
"Analysez l'architecture globale de ce projet, expliquez les modules principaux et leurs relations"
# Modules principaux
"Expliquez comment fonctionne le module src/auth, y compris le flux d'authentification et les vérifications de permissions"
# Traçage du flux de données
"Tracez le flux complet depuis la requête jusqu'à la réponse après la connexion de l'utilisateur"
# Résumé clé
"Résumez les patrons de conception principaux de ce projet et les points nécessitant une attention particulière"
"Analysez l'architecture globale de ce projet, expliquez les modules principaux et leurs relations"
# Modules principaux
"Expliquez comment fonctionne le module src/auth, y compris le flux d'authentification et les vérifications de permissions"
# Traçage du flux de données
"Tracez le flux complet depuis la requête jusqu'à la réponse après la connexion de l'utilisateur"
# Résumé clé
"Résumez les patrons de conception principaux de ce projet et les points nécessitant une attention particulière"
Prendre rapidement en main de nouveaux projets
Guide de démarrage pour les nouveaux projets
# Vue d'ensemble du projet
"Qu'est-ce que ce projet ? Quelles sont ses principales fonctionnalités et sa pile technologique ?"
# Guide de développement
"Comment démarrer l'environnement de développement local ? Comment exécuter les tests ?"
# Normes de code
"Quelles sont les normes de code pour ce projet ? Quelles conventions existent ?"
# Navigation dans les modules
Quels fichiers doivent être modifiés pour ajouter la fonctionnalité X ?
"Qu'est-ce que ce projet ? Quelles sont ses principales fonctionnalités et sa pile technologique ?"
# Guide de développement
"Comment démarrer l'environnement de développement local ? Comment exécuter les tests ?"
# Normes de code
"Quelles sont les normes de code pour ce projet ? Quelles conventions existent ?"
# Navigation dans les modules
Quels fichiers doivent être modifiés pour ajouter la fonctionnalité X ?
Flux de travail de refactorisation
La refactorisation nécessite une manipulation prudente ; Codex peut vous aider à améliorer systématiquement la structure du code.
Principes de refactorisation
- Comprendre d'abord la structure de code existante
- Refactoriser par petites étapes, améliorer progressivement
- Valider à chaque étape pour garantir que la fonctionnalité reste inchangée
- Maintenir la couverture des tests
Étapes du processus de refactorisation
| Étapes | Description |
|---|---|
| Identifier les problèmes | Codex analyse le code et identifie les zones à améliorer |
| Élaborer un plan | Discuter du plan de refactorisation, confirmer la direction des améliorations |
| Exécuter étape par étape | Effectuer des modifications à petite échelle, valider après chaque modification |
| Tester et vérifier | Exécuter tous les tests pour vérifier que la fonctionnalité est correcte |
| Nettoyer et optimiser | Supprimer le code redondant, optimiser le nommage |
Exemple de refactorisation
# Identifier les problèmes
Analyser le module src/utils, identifier la duplication de code et les conceptions déraisonnables
# Élaborer un plan
Discuter de la manière de refactoriser ce module tout en maintenant la rétrocompatibilité
# Exécuter étape par étape
Étape 1 : Extraire les fonctions communes dans utils/common.py
# Tester et vérifier
Exécuter tous les tests pour confirmer que la refactorisation n’a pas cassé les fonctionnalités
# Passer à l’étape suivante
Étape 2 : Simplifier les fonctions complexes en les divisant en unités plus petites
Analyser le module src/utils, identifier la duplication de code et les conceptions déraisonnables
# Élaborer un plan
Discuter de la manière de refactoriser ce module tout en maintenant la rétrocompatibilité
# Exécuter étape par étape
Étape 1 : Extraire les fonctions communes dans utils/common.py
# Tester et vérifier
Exécuter tous les tests pour confirmer que la refactorisation n’a pas cassé les fonctionnalités
# Passer à l’étape suivante
Étape 2 : Simplifier les fonctions complexes en les divisant en unités plus petites
Lors de la refactorisation, utilisez le mode /plan pour créer d’abord un plan, puis exécutez étape par étape pour éviter de grandes modifications ponctuelles.
Flux de correction de bug
Codex peut vous aider à localiser et corriger rapidement les bugs.
Flux de correction
| Étapes | Opération |
|---|---|
| Décrivez le problème | Décrivez les symptômes du bug et les conditions de déclenchement |
| Fournissez des informations | Partagez les messages d'erreur, les journaux et les captures d'écran |
| Trouver la cause racine | Codex analyse et trouve la cause racine |
| Générer la correction | Codex propose une correction |
| Vérifier la correction | Exécuter les tests pour confirmer que les problèmes sont résolus |
| Prévenir la récurrence | Ajouter des tests pour couvrir ce scénario |
Exemple de correction de bug
# Décrire le problème
Les utilisateurs rencontrent occasionnellement des erreurs 500 lors de la connexion, et le journal des erreurs affiche :
TypeError: Cannot read property 'id' of undefined"
# Fournir des informations
Voici la pile d'erreurs complète : [collez les informations de pile]
# Trouver la cause racine
Après analyse, Codex a trouvé le problème : l'objet utilisateur est null dans certains cas
# Générer le correctif
Corrigez ce problème et assurez-vous qu'il n'affecte pas le flux de connexion normal
# Vérifier la correction
Exécutez tous les tests liés à la connexion
# Prévenir la récurrence
"Ajoutez un test couvrant le scénario où l'objet user est null"
Les utilisateurs rencontrent occasionnellement des erreurs 500 lors de la connexion, et le journal des erreurs affiche :
TypeError: Cannot read property 'id' of undefined"
# Fournir des informations
Voici la pile d'erreurs complète : [collez les informations de pile]
# Trouver la cause racine
Après analyse, Codex a trouvé le problème : l'objet utilisateur est null dans certains cas
# Générer le correctif
Corrigez ce problème et assurez-vous qu'il n'affecte pas le flux de connexion normal
# Vérifier la correction
Exécutez tous les tests liés à la connexion
# Prévenir la récurrence
"Ajoutez un test couvrant le scénario où l'objet user est null"
Débogage assisté par captures d'écran
Utilisez des captures d'écran pour aider Codex à comprendre le problème :
Entrée d'image
# Joindre une capture d'écran dans la CLI
codex -i error-screenshot.png "Expliquez cette erreur et corrigez-la"
# Coller la capture d'écran dans l'IDE
Collez la capture d'écran directement dans la conversation et décrivez le problème
codex -i error-screenshot.png "Expliquez cette erreur et corrigez-la"
# Coller la capture d'écran dans l'IDE
Collez la capture d'écran directement dans la conversation et décrivez le problème
Flux de travail de revue de code
Codex peut examiner les modifications de code, identifier les problèmes et fournir des suggestions d'amélioration.
Mode Révision
| Mode | Méthode de déclenchement | Scénarios applicables |
|---|---|---|
| Mode Révision | Activer dans l'application | Examiner les modifications locales non commitées |
| commande /review | Utiliser dans CLI/IDE | Examiner les modifications dans un périmètre spécifié |
| Intégration GitHub | @codex review dans la PR | Examiner la Pull Request |
Révision locale
Mode Révision
# Activer le mode révision dans l'application
Cliquez sur l'icône en forme d'œil dans la barre d'outils
# Ou utilisez-le dans CLI
/revue
# Spécifier la portée de la revue
/review src/auth/
# Examiner des commits spécifiques
/review HEAD~3..HEAD
Cliquez sur l'icône en forme d'œil dans la barre d'outils
# Ou utilisez-le dans CLI
/revue
# Spécifier la portée de la revue
/review src/auth/
# Examiner des commits spécifiques
/review HEAD~3..HEAD
Personnaliser le focus de la revue
Spécifier le focus de la revue
# Revue de sécurité
/review pour problèmes de sécurité
# Revue de performance
/review pour régressions de performance
# Style de code
/review pour cohérence de style de code
# Revue complète
/review --detailed
/review pour problèmes de sécurité
# Revue de performance
/review pour régressions de performance
# Style de code
/review pour cohérence de style de code
# Revue complète
/review --detailed
Flux de travail d'écriture de tests
Codex peut vous aider à écrire et à maintenir du code de test.
Tests de nouvelles fonctionnalités
Écrire des tests
# Écrire des tests pour la nouvelle fonctionnalité
"Écrire des tests unitaires pour le point de terminaison GET de src/api/users.py,
couvrant les réponses normales, la liste vide, les limites de pagination et d'autres scénarios"
# Vérifier les tests
"Exécuter les tests nouvellement écrits"
# Compléter la couverture
"Vérifier la couverture des tests et compléter les cas limites non couverts"
"Écrire des tests unitaires pour le point de terminaison GET de src/api/users.py,
couvrant les réponses normales, la liste vide, les limites de pagination et d'autres scénarios"
# Vérifier les tests
"Exécuter les tests nouvellement écrits"
# Compléter la couverture
"Vérifier la couverture des tests et compléter les cas limites non couverts"
Corriger les tests
Corriger les tests en échec
# Analyser les tests en échec
"Le test test_user_login a échoué ; analyser la cause et le corriger"
# Correction par lots
"Exécuter tous les tests et corriger les tests en échec"
"Le test test_user_login a échoué ; analyser la cause et le corriger"
# Correction par lots
"Exécuter tous les tests et corriger les tests en échec"
Flux de travail de génération de documentation
Codex peut aider à générer et mettre à jour la documentation.
Générer la documentation
Génération de documentation
# Documentation de l'API
"Générer la documentation de l'API pour le module src/api, y compris les formats de requête et de réponse pour chaque point de terminaison."
# Mise à jour du README
"Mettre à jour README.md, en ajoutant des descriptions et des exemples d'utilisation pour les nouvelles fonctionnalités."
# Commentaires en ligne
"Ajouter des commentaires aux fonctions complexes, en expliquant la logique clé."
"Générer la documentation de l'API pour le module src/api, y compris les formats de requête et de réponse pour chaque point de terminaison."
# Mise à jour du README
"Mettre à jour README.md, en ajoutant des descriptions et des exemples d'utilisation pour les nouvelles fonctionnalités."
# Commentaires en ligne
"Ajouter des commentaires aux fonctions complexes, en expliquant la logique clé."
Bonnes pratiques
Sélection du flux de travail
- Développement quotidien : interaction continue, amélioration itérative
- Refactorisation : planifier d'abord, puis exécuter, valider par petites étapes
- Correction de bug : fournir suffisamment d'informations et vérifier la cause racine
- Revue : effectuer régulièrement, se concentrer sur les problèmes de sécurité
Conseils d'efficacité
- Utiliser AGENTS.md pour définir les conventions du projet, en réduisant les instructions répétitives
- Utiliser Skills pour encapsuler les flux de travail courants
- Utiliser Worktree pour isoler les différentes tâches
- Configurez une politique d'approbation raisonnable
FAQ
Q: Comment gérer une refactorisation à grande échelle ?
Utilisez le mode /plan pour créer un plan étape par étape, en vérifiant après chaque étape.
Q: Comment empêcher les bugs de réapparaître après correction ?
Ajoutez des tests dédiés pour couvrir ce scénario, et ajoutez des règles de contrôle pertinentes dans AGENTS.md.
Q: Comment aider Codex à comprendre les conventions du projet ?
Créez un fichier AGENTS.md pour définir la stack technique du projet, les conventions de code, les exigences de test, etc.
Q: Comment les résultats de revue sont-ils partagés avec l'équipe ?
Utilisez l'intégration GitHub pour effectuer la revue dans la PR, les résultats seront automatiquement ajoutés sous forme de commentaires.
autres extensions