Revisa solicitudes de incorporación de cambios de GitHub con Codex

Usa la revisión de código de Codex para obtener otra revisión de alta calidad de las solicitudes de incorporación de cambios de GitHub. Codex revisa el diff de la solicitud de incorporación de cambios, sigue las directrices de tu repositorio y publica una revisión de código estándar de GitHub centrada en problemas graves. Security Review, disponible como versión preliminar de investigación, proporciona una revisión más exhaustiva de los posibles problemas de seguridad de una solicitud de incorporación de cambios.

Ver: recorrido guiado por la revisión de código de Codex

Antes de comenzar

Asegúrate de tener:

• Codex cloud configurado para el repositorio que quieres revisar.
• Acceso a la configuración de revisión de código de Codex.
• Un archivo AGENTS.md si quieres que Codex siga directrices de revisión específicas del repositorio.

Configurar la revisión de código de Codex

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

1. Configura Codex cloud.
2. Ve a la configuración de Codex.
3. Activa Revisión de código para tu repositorio.

Solicita una revisión de Codex

1. En un comentario de una solicitud de incorporación de cambios, menciona @codex review.
2. Espera a que Codex reaccione (👀) y publique una revisión.

Codex publica una revisión en la solicitud de incorporación de cambios, como lo haría un compañero de equipo. En GitHub, Codex solo señala los problemas P0 y P1 para que los comentarios de la revisión se centren en los riesgos de alta prioridad.

Habilita las revisiones automáticas

Si quieres que Codex revise automáticamente todas las solicitudes de incorporación de cambios, activa Revisiones automáticas en la configuración de Codex. Codex publicará una revisión cada vez que alguien abra una nueva PR para revisión, sin necesidad de un comentario @codex review.

Personalizar lo que revisa Codex

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

Por ejemplo, un servicio de informes de experimentos puede impedir que el comportamiento posterior a la exposición modifique una cohorte de comparación:

## Code Review Rules

### Experiment cohorts

- Do not filter treatment comparisons on post-exposure behavior, including conversion or retention.
  Safe path: build cohorts from assignment or exposure; report conversion as an outcome.

Coloca las reglas para todo el repositorio en el archivo AGENTS.md raíz y las reglas específicas del servicio en un archivo anidado, como services/experiment_reporting/AGENTS.md. Codex aplica las directrices raíz y las más específicas que abarquen cada archivo modificado, de modo que los cambios no relacionados no tengan que incluir contexto específico del servicio.

Comienza con dos o tres reglas concisas que expresen comprobaciones que los revisores explican con frecuencia. Algunas reglas útiles:

• Céntrate en comportamientos importantes y específicos del repositorio. Describe la restricción de compatibilidad, el límite de datos o el efecto secundario inseguro que se debe marcar y por qué es importante.
• Indica la ruta segura o la excepción. Proporciona a Codex suficiente contexto para distinguir un problema real del comportamiento esperado.
• Mantén las reglas acotadas y duraderas. Prioriza los resultados sobre nombres de funciones que puedan cambiar y coloca las directrices cerca del código que rigen.
• Deja las comprobaciones mecánicas en CI. Excluye de las reglas de revisión el formato, el lint y otras comprobaciones deterministas.

Abre una solicitud de incorporación de cambios representativa y solicita una revisión con @codex review. Perfecciona las reglas según los hallazgos y comentarios que observes, y limita o elimina las directrices que generen ruido.

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

Para centrar una revisión puntual en algo concreto, añádelo al comentario de tu solicitud de incorporación de cambios:

@codex review for issues in the database migration

Revisión de seguridad

La revisión de seguridad es una revisión adicional para los clientes que quieren prestar especial atención a los problemas de seguridad en las solicitudes de incorporación de cambios. Analiza los riesgos específicos de seguridad con mayor profundidad que la revisión de código mediante el análisis del diff de la solicitud de incorporación de cambios, el contexto complementario del repositorio y los modelos de amenazas o las directrices de seguridad configurados.

La revisión de código también puede identificar problemas relacionados con la seguridad como parte de su revisión general, por lo que es posible que ocasionalmente haya coincidencias entre los hallazgos de la revisión de código y la revisión de seguridad.

Configura la revisión de seguridad

Para obtener instrucciones de configuración y opciones más detalladas, consulta Security Review.

1. Configura Codex cloud.
2. Ve a la configuración de Codex.
3. En Preferencias del repositorio, elige qué solicitudes de incorporación de cambios recibirán la revisión de seguridad y cuándo se ejecutará. Selecciona Siempre que se ejecute la revisión de código para ejecutarla junto con la revisión de código.

Solicita una revisión de seguridad

Para solicitar una revisión de seguridad manualmente, añade este comentario a una solicitud de incorporación de cambios:

@codex security review

Codex reacciona mientras se ejecuta la revisión y después publica los hallazgos de seguridad directamente en la solicitud de incorporación de cambios. Abre la tarea de Codex asociada y selecciona la pestaña Informe de seguridad para ver el informe completo.

Actuar sobre los hallazgos de la revisión

Después de que Codex publique una revisión, puedes pedirle que corrija los problemas en la misma solicitud de incorporación de cambios dejando otro comentario:

@codex fix the P1 issue

Codex inicia un chat en la nube con la solicitud de incorporación de cambios como contexto y puede enviar una corrección a la rama cuando tenga permiso para hacerlo.

Asignar otras tareas a Codex

Si mencionas @codex en un comentario con cualquier contenido distinto de review, Codex inicia un chat en la nube usando tu solicitud de incorporación de cambios como contexto.

@codex fix the CI failures

Solucionar problemas de la revisión de código

Si Codex no reacciona ni publica una revisión:

• Confirma que hayas activado Code review para el repositorio en la configuración de Codex.
• Confirma que la solicitud de incorporación de cambios pertenezca a un repositorio con Codex cloud configurado.
• Usa el activador exacto @codex review en un comentario de la solicitud de incorporación de cambios.
• Para las revisiones automáticas, comprueba que hayas activado Revisiones automáticas y que el evento de la solicitud de incorporación de cambios coincida con la configuración del activador de revisión.