Revisa pull requests de GitHub con Codex

Usa la revisión de código de Codex para que tus pull requests de GitHub reciban una revisión adicional centrada en los problemas importantes. Codex examina los cambios del pull request, sigue las pautas de tu repositorio y publica una revisión de código estándar de GitHub que señala los problemas graves. La revisión de seguridad, disponible en versión preliminar de investigación, analiza con mayor profundidad los posibles problemas de seguridad de un pull request.

Antes de empezar

Asegúrate de tener lo siguiente:

• Un repositorio de GitHub conectado a Codex. Para configurar la integración anterior, consulta Codex Cloud (versión anterior).
• Acceso a la configuración de revisión de código de Codex.
• Un archivo AGENTS.md si quieres que Codex siga pautas de revisión específicas del repositorio.

Configura la revisión de código de Codex

Para configurar las revisiones automáticas, necesitas un repositorio de GitHub conectado y permisos de escritura o de administración en GitHub para modificar su configuración.

1. Conecta tu repositorio de GitHub a Codex.
2. Ve a la configuración de Codex.
3. Selecciona tu repositorio y activa Revisión automática en Revisar código.

Solicita una revisión de Codex

1. Menciona @codex review en un comentario del pull request.
2. Espera a que Codex reaccione (👀) y publique una revisión.

dkundel-openaicommented21 minutes agoAuthor

@codex review

Codex publica una revisión en el pull request, como lo haría alguien de tu equipo. En GitHub, Codex solo señala problemas P0 y P1 para que los comentarios de revisión se centren en los riesgos de alta prioridad.

Activa las revisiones automáticas

Para activar las revisiones automáticas de tus pull requests, activa Revisión automática en Preferencias personales dentro de la configuración de Codex. Elige cuándo se ejecutan las revisiones con Evento que inicia la revisión. Esta configuración se aplica a los repositorios que tienen activada la revisión de código y no requiere un comentario con @codex review.

Personaliza lo que revisa Codex

Codex busca archivos AGENTS.md en tu repositorio y sigue las reglas de revisión de código que correspondan. Agrega una sección ## Code Review Rules al archivo más cercano al código al que se aplican las reglas. Usa encabezados ### para agrupar comprobaciones relacionadas cuando te resulte útil.

Por ejemplo, un servicio que genera informes de experimentos puede evitar que el comportamiento posterior a la exposición altere la composición de una cohorte de comparación:

## Code Review Rules

### Cohortes del experimento

- Al comparar tratamientos, no filtres las cohortes según el comportamiento posterior a la exposición, como la conversión o la retención.
  Para hacerlo de forma segura, forma las cohortes a partir de la asignación o de la exposición e informa la conversión como resultado.

Coloca las reglas de todo el repositorio en el archivo AGENTS.md de la raíz y las reglas específicas de un servicio en un archivo de un subdirectorio, como services/experiment_reporting/AGENTS.md. Para cada archivo modificado, Codex aplica tanto las pautas de la raíz como las pautas más específicas que le correspondan. Así, los cambios ajenos al servicio no necesitan incluir el contexto de ese servicio.

Empieza con dos o tres reglas breves que recojan las comprobaciones que suelen explicar quienes revisan el código. Al escribir las reglas, ten en cuenta lo siguiente:

• Céntrate en los comportamientos propios del repositorio que tengan consecuencias importantes. Describe la restricción de compatibilidad, el límite en el uso de los datos o el efecto secundario inseguro que se debe señalar y explica por qué importa.
• Indica cómo proceder de forma segura o cuándo se aplica una excepción. Dale a Codex suficiente contexto para distinguir un problema real de un comportamiento esperado.
• Delimita el alcance de las reglas y procura que sigan vigentes. Describe los resultados esperados en vez de usar nombres de funciones que pueden cambiar. Coloca las pautas cerca del código al que se aplican.
• Deja las comprobaciones mecánicas en la integración continua. Excluye de las reglas de revisión las comprobaciones de formato, de lint y de otros aspectos que puedan verificarse de manera determinista.

Abre un pull request representativo y solicita una revisión con @codex review. Ajusta las reglas a partir de los hallazgos y los comentarios que recibas. Limita el alcance de las pautas que generen comentarios irrelevantes o elimínalas.

Las reglas de revisión de código orientan a Codex. No sustituyen las pruebas, las protecciones de ramas ni las aprobaciones obligatorias.

Si quieres que una revisión se centre en un aspecto concreto, indícalo en tu comentario del pull request:

@codex review busca problemas en la migración de la base de datos

Revisión de seguridad

La revisión de seguridad es una revisión adicional para quienes quieren prestar especial atención a los problemas de seguridad en los pull requests. Examina los riesgos de seguridad con más detalle que la revisión de código. Para ello, analiza los cambios del pull request, el contexto pertinente del repositorio y los modelos de amenazas o las pautas de seguridad que se hayan configurado.

La revisión de código también puede detectar problemas de seguridad como parte de su análisis general, por lo que en ocasiones ambas revisiones pueden señalar el mismo problema.

Configura la revisión de seguridad

Para obtener instrucciones más detalladas y consultar las opciones de configuración, ve a Revisión de seguridad.

1. Conecta tu repositorio de GitHub a Codex.
2. Ve a la configuración de Codex.
3. Selecciona tu repositorio. En Revisar vulnerabilidades de seguridad, activa Revisión de seguridad automática y usa Revisar para elegir de quiénes se revisarán los pull requests. En Evento de activación, selecciona Cada vez que se ejecute la revisión de código para que ambas revisiones se ejecuten juntas.

Solicita una revisión de seguridad

Para solicitar una revisión de seguridad manualmente, agrega este comentario a un pull request:

@codex security review

Codex reacciona al comentario mientras se ejecuta la revisión y luego publica los hallazgos de seguridad directamente en el pull request. Abre la tarea de Codex asociada y selecciona la pestaña Informe de seguridad para ver el informe completo.

Soluciona problemas con la revisión de código

Si Codex no reacciona o no publica una revisión:

• Confirma que activaste la revisión de código para el repositorio en la configuración de Codex.
• Confirma que el pull request pertenece a un repositorio de GitHub conectado a Codex.
• Usa exactamente @codex review en un comentario del pull request para iniciar la revisión.
• Para las revisiones automáticas, verifica que Revisión automática esté activada tanto en la configuración del repositorio como en Preferencias personales dentro de la configuración de Codex. Confirma que el evento del pull request coincida con el que configuraste para iniciar la revisión.