Patrones de flujo de trabajo de Codex
Codex puede integrarse en varios flujos de trabajo de desarrollo, desde la codificación diaria hasta refactorizaciones complejas, mejorando significativamente la eficiencia.
Flujo de trabajo de desarrollo diario
El desarrollo diario es el patrón de flujo de trabajo más común, adecuado para construir nuevas funciones o realizar modificaciones a pequeña escala.
Pasos del flujo de trabajo
| Paso | Acción | Interacción con Codex |
|---|---|---|
| 1 | Definir los requisitos | Describe la función que deseas implementar |
| 2 | Análisis de Codex | Codex comprende la estructura y las normas del proyecto |
| 3 | Discusión del plan | Confirma el plan de implementación con Codex |
| 4 | Generación de código | Codex escribe el código y modifica archivos |
| 5 | Pruebas de verificación | Ejecuta las pruebas para confirmar que la función es correcta |
| 6 | Optimización iterativa | Ajusta el código según los comentarios |
Ejemplo: Añadir un nuevo endpoint de API
Proceso de desarrollo diario
# Paso 1: Describe los requisitos
"Añade un endpoint GET en la ruta /api/users que devuelva la lista de usuarios,
que admita los parámetros de paginación page y limit"
# Pasos 2-3: Codex analiza y confirma el plan
Codex analizará la estructura de la API existente y confirmará:
- Ubicación de las definiciones de rutas
- Método de consulta a la base de datos
- Normas de formato de respuesta
# Paso 4: Generación de código
Codex crea automáticamente:
- Definición de rutas
- Lógica de consulta de datos
- Manejo de errores
- Formateo de respuestas
# Paso 5: Pruebas de verificación
"Ejecuta las pruebas y verifica el nuevo endpoint"
# Paso 6: Optimización iterativa
"Añade soporte de caché, el tiempo de respuesta debe ser inferior a 100 ms"
"Añade un endpoint GET en la ruta /api/users que devuelva la lista de usuarios,
que admita los parámetros de paginación page y limit"
# Pasos 2-3: Codex analiza y confirma el plan
Codex analizará la estructura de la API existente y confirmará:
- Ubicación de las definiciones de rutas
- Método de consulta a la base de datos
- Normas de formato de respuesta
# Paso 4: Generación de código
Codex crea automáticamente:
- Definición de rutas
- Lógica de consulta de datos
- Manejo de errores
- Formateo de respuestas
# Paso 5: Pruebas de verificación
"Ejecuta las pruebas y verifica el nuevo endpoint"
# Paso 6: Optimización iterativa
"Añade soporte de caché, el tiempo de respuesta debe ser inferior a 100 ms"
Flujo de trabajo de comprensión de código
Utiliza este flujo de trabajo cuando necesites comprender código legado o proyectos desconocidos.
Flujo de trabajo exploratorio
- Comienza desde el punto de entrada y haz que Codex explique la arquitectura general
- Profundiza gradualmente en los módulos clave para entender la lógica central
- Rastrea los flujos de datos y las cadenas de llamadas
- Resume los puntos clave y las consideraciones
Comprender proyectos legados
# Arquitectura general
"Analiza la arquitectura general de este proyecto y explica los módulos principales y sus relaciones"
# Módulos principales
"Explica cómo funciona el módulo src/auth, incluidos el flujo de autenticación y la verificación de permisos"
# Rastreo de flujo de datos
"Rastrea el flujo completo desde la solicitud hasta la respuesta después del inicio de sesión del usuario"
# Resumen clave
"Resume los patrones de diseño centrales de este proyecto y los puntos a tener en cuenta"
"Analiza la arquitectura general de este proyecto y explica los módulos principales y sus relaciones"
# Módulos principales
"Explica cómo funciona el módulo src/auth, incluidos el flujo de autenticación y la verificación de permisos"
# Rastreo de flujo de datos
"Rastrea el flujo completo desde la solicitud hasta la respuesta después del inicio de sesión del usuario"
# Resumen clave
"Resume los patrones de diseño centrales de este proyecto y los puntos a tener en cuenta"
Puesta en marcha rápida de nuevos proyectos
Guía para empezar con nuevos proyectos
# Resumen del proyecto
"¿Qué es este proyecto? ¿Cuáles son sus funciones principales y su pila tecnológica?"
# Guía de desarrollo
"¿Cómo iniciar el entorno de desarrollo localmente? ¿Cómo ejecutar las pruebas?"
# Normas de código
"¿Cuáles son las normas de código de este proyecto? ¿Qué convenciones tiene?"
# Navegación de módulos
"Si quieres añadir la función X, ¿qué archivos deberías modificar?"
"¿Qué es este proyecto? ¿Cuáles son sus funciones principales y su pila tecnológica?"
# Guía de desarrollo
"¿Cómo iniciar el entorno de desarrollo localmente? ¿Cómo ejecutar las pruebas?"
# Normas de código
"¿Cuáles son las normas de código de este proyecto? ¿Qué convenciones tiene?"
# Navegación de módulos
"Si quieres añadir la función X, ¿qué archivos deberías modificar?"
Flujo de trabajo de refactorización
La refactorización requiere un manejo cuidadoso; Codex puede ayudarte a mejorar la estructura del código de forma sistemática.
Principios de refactorización
- Primero comprende la estructura de código existente
- Refactoriza en pequeños pasos y mejora gradualmente
- Verifica en cada paso para asegurar que el comportamiento no cambie
- Mantén la cobertura de pruebas
Pasos del flujo de trabajo de refactorización
| Paso | Descripción |
|---|---|
| Identificar problemas | Codex analiza el código e identifica las partes que necesitan mejoras |
| Elaborar un plan | Discute el plan de refactorización y confirma la dirección de mejora |
| Ejecución por pasos | Realiza modificaciones a pequeña escala y verifica después de cada cambio |
| Verificación con pruebas | Ejecuta todas las pruebas para asegurar que la funcionalidad sea correcta |
| Limpieza y optimización | Elimina código redundante y optimiza los nombres |
Ejemplo de refactorización
# Identificar problemas
"Analiza el módulo src/utils e identifica código duplicado y diseños inapropiados"
# Elaborar un plan
"Discute cómo refactorizar este módulo manteniendo la compatibilidad hacia atrás"
# Ejecución por pasos
"Paso 1: Extrae las funciones comunes a utils/common.py"
# Verificación con pruebas
"Ejecuta todas las pruebas y confirma que la refactorización no ha roto la funcionalidad"
# Continuar con el siguiente paso
"Paso 2: Simplifica las funciones complejas dividiéndolas en unidades más pequeñas"
"Analiza el módulo src/utils e identifica código duplicado y diseños inapropiados"
# Elaborar un plan
"Discute cómo refactorizar este módulo manteniendo la compatibilidad hacia atrás"
# Ejecución por pasos
"Paso 1: Extrae las funciones comunes a utils/common.py"
# Verificación con pruebas
"Ejecuta todas las pruebas y confirma que la refactorización no ha roto la funcionalidad"
# Continuar con el siguiente paso
"Paso 2: Simplifica las funciones complejas dividiéndolas en unidades más pequeñas"
Al refactorizar, usa el modo /plan para elaborar un plan primero y luego ejecútalo por pasos, evitando cambios grandes de una sola vez.
Flujo de trabajo de corrección de errores
Codex puede ayudarte a localizar y corregir errores rápidamente.
Proceso de corrección
| Paso | Acción |
|---|---|
| Describir el problema | Explica la manifestación del error y las condiciones que lo desencadenan |
| Proporcionar información | Comparte mensajes de error, registros y capturas de pantalla |
| Localizar la causa raíz | Codex analiza y encuentra la causa raíz |
| Generar la corrección | Codex propone un plan de corrección |
| Verificar la corrección | Ejecuta pruebas para confirmar que el problema está resuelto |
| Prevenir la recurrencia | Añade una prueba que cubra ese escenario |
Ejemplo de corrección de errores
# Describir el problema
"Ocasionalmente aparece un error 500 al iniciar sesión, el registro de errores muestra:
TypeError: Cannot read property 'id' of undefined"
# Proporcionar información
"Esta es la traza de error completa: [pegar información de la traza]"
# Localizar la causa raíz
Después del análisis, Codex descubre el problema: el objeto de usuario es null en algunos casos
# Generar la corrección
"Corrige este problema y asegúrate de que no afecte al flujo normal de inicio de sesión"
# Verificar la corrección
"Ejecuta todas las pruebas relacionadas con el inicio de sesión"
# Prevenir la recurrencia
"Añade una prueba que cubra el escenario en el que el objeto de usuario es null"
"Ocasionalmente aparece un error 500 al iniciar sesión, el registro de errores muestra:
TypeError: Cannot read property 'id' of undefined"
# Proporcionar información
"Esta es la traza de error completa: [pegar información de la traza]"
# Localizar la causa raíz
Después del análisis, Codex descubre el problema: el objeto de usuario es null en algunos casos
# Generar la corrección
"Corrige este problema y asegúrate de que no afecte al flujo normal de inicio de sesión"
# Verificar la corrección
"Ejecuta todas las pruebas relacionadas con el inicio de sesión"
# Prevenir la recurrencia
"Añade una prueba que cubra el escenario en el que el objeto de usuario es null"
Depuración asistida por capturas de pantalla
Usa capturas de pantalla para ayudar a Codex a comprender el problema:
Entrada de imágenes
# Adjuntar captura de pantalla en la CLI
codex -i error-screenshot.png "Explica este error y corrígelo"
# Pegar captura de pantalla en el IDE
Pega la captura de pantalla directamente en la conversación y describe el problema
codex -i error-screenshot.png "Explica este error y corrígelo"
# Pegar captura de pantalla en el IDE
Pega la captura de pantalla directamente en la conversación y describe el problema
Flujo de trabajo de revisión de código
Codex puede revisar los cambios de código, detectar problemas y ofrecer sugerencias de mejora.
Modo de revisión
| Modo | Forma de activación | Casos de uso |
|---|---|---|
| Review Mode | Habilitar en la App | Revisar cambios locales no confirmados |
| Comando /review | Uso en CLI/IDE | Revisar cambios de un rango específico |
| Integración con GitHub | Usar @codex review en el PR | Revisar Pull Request |
Revisión local
Review Mode
# Habilitar Review Mode en la App
Haz clic en el icono del ojo en la barra de herramientas
# O usar en la CLI
/review
# Especificar el rango de revisión
/review src/auth/
# Revisar commits específicos
/review HEAD~3..HEAD
Haz clic en el icono del ojo en la barra de herramientas
# O usar en la CLI
/review
# Especificar el rango de revisión
/review src/auth/
# Revisar commits específicos
/review HEAD~3..HEAD
Personalización del enfoque de revisión
Especificar el enfoque de revisión
# Revisión de seguridad
/review for security issues
# Revisión de rendimiento
/review for performance regressions
# Estilo de código
/review for code style consistency
# Revisión integral
/review --detailed
/review for security issues
# Revisión de rendimiento
/review for performance regressions
# Estilo de código
/review for code style consistency
# Revisión integral
/review --detailed
Flujo de trabajo de escritura de pruebas
Codex puede ayudarte a escribir y mantener código de pruebas.
Pruebas de nuevas funciones
Escribir pruebas
# Escribir pruebas para nuevas funcionalidades
"Escribe pruebas unitarias para el endpoint GET de src/api/users.py,
cubriendo escenarios como respuesta normal, lista vacía, límites de paginación, etc."
# Verificar pruebas
"Ejecuta las pruebas recién escritas"
# Ampliar cobertura
"Revisa la cobertura de pruebas y añade los casos límite no cubiertos"
"Escribe pruebas unitarias para el endpoint GET de src/api/users.py,
cubriendo escenarios como respuesta normal, lista vacía, límites de paginación, etc."
# Verificar pruebas
"Ejecuta las pruebas recién escritas"
# Ampliar cobertura
"Revisa la cobertura de pruebas y añade los casos límite no cubiertos"
Corrección de pruebas
Corregir pruebas fallidas
# Analizar pruebas fallidas
"La prueba test_user_login ha fallado, analiza la causa y corrígela"
# Corrección en lote
"Ejecuta todas las pruebas y corrige las que fallen"
"La prueba test_user_login ha fallado, analiza la causa y corrígela"
# Corrección en lote
"Ejecuta todas las pruebas y corrige las que fallen"
Flujo de trabajo de generación de documentación
Codex puede ayudarte a generar y actualizar documentación.
Generar documentación
Generación de documentación
# Documentación de API
"Genera documentación de API para el módulo src/api, incluyendo el formato de solicitud y respuesta de cada endpoint"
# Actualización de README
"Actualiza README.md, añade la descripción de la nueva funcionalidad y ejemplos de uso"
# Comentarios en línea
"Añade comentarios a funciones complejas explicando la lógica clave"
"Genera documentación de API para el módulo src/api, incluyendo el formato de solicitud y respuesta de cada endpoint"
# Actualización de README
"Actualiza README.md, añade la descripción de la nueva funcionalidad y ejemplos de uso"
# Comentarios en línea
"Añade comentarios a funciones complejas explicando la lógica clave"
Mejores prácticas
Selección de flujos de trabajo
- Desarrollo diario: interacción continua, mejora progresiva
- Refactorización: planificar antes de ejecutar, verificar en pasos pequeños
- Corrección de errores: proporcionar información suficiente, verificar la causa raíz
- Revisión: realizar periódicamente, prestar atención a problemas de seguridad
Consejos de eficiencia
- Usa AGENTS.md para definir las normas del proyecto y reducir explicaciones repetidas
- Utiliza Skills para encapsular flujos de trabajo habituales
- Usa Worktree para aislar diferentes tareas
- Configura una política de Approval razonable
Preguntas frecuentes
P: ¿Cómo manejar una refactorización a gran escala?
Usa el modo /plan para elaborar un plan por pasos y verifica después de cada paso.
P: ¿Cómo evitar que un error se repita después de corregirlo?
Añade pruebas específicas que cubran ese escenario y agrega reglas de verificación relevantes en AGENTS.md.
P: ¿Cómo hacer que Codex comprenda las normas del proyecto?
Crea un archivo AGENTS.md que defina la pila tecnológica, las normas de código, los requisitos de prueba, etc.
P: ¿Cómo compartir los resultados de la revisión con el equipo?
Usa la integración con GitHub para revisar en el PR; los resultados se añadirán automáticamente como comentarios.
Otras extensiones