Revisión de código

Revisión de pull requests

El complemento Revisión de código muestra la descripción de un pull request, los archivos modificados, los comentarios y las verificaciones. Úsalo para investigar posibles problemas antes de aprobar el pull request.

La revisión de código para GitHub ya está disponible de forma general. En Revisión de código, la compatibilidad con los merge requests de GitLab está en versión preliminar. Para iniciar revisiones en la nube desde GitLab con @codex review o mediante revisiones automáticas de merge requests, consulta Revisar merge requests de GitLab con Codex.

Para las revisiones que se inician desde el repositorio, consulta la guía de integración con GitHub y la guía de configuración del entorno de Codex Cloud (versión anterior).

La aplicación de escritorio incluye Revisión de código. Puedes fijar el complemento en la barra lateral de la aplicación desde la lista de complementos instalados.

Ver un pull request

1. Abre Revisión de código desde la barra lateral.
2. Cuando se te solicite, conecta tu cuenta del proveedor del repositorio. Usa una cuenta con acceso al repositorio que quieres revisar.
3. Selecciona un pull request en la barra lateral o ingresa su enlace en el campo de búsqueda.
4. Consulta Resumen para ver la descripción, la actividad, los comentarios y las verificaciones. Abre Cambios para examinar los archivos modificados y los comentarios junto al diff.

Encontrar revisiones que requieren atención

Usa tu bandeja de entrada personal para encontrar pull requests de GitHub en distintos repositorios. Elige Asignados a mí para ver los pull requests que te pidieron revisar, Asignados a mi equipo para ver los que le pidieron revisar a tu equipo o Creados por mí para volver a tus propios cambios. Consulta el estado de la revisión y abre el pull request para examinar los comentarios y las verificaciones.

Para volver a una revisión más tarde, selecciona el ícono de chincheta en su barra de herramientas. El pull request aparecerá en Fijados en la barra lateral.

Examinar archivos modificados y pull requests relacionados

En Cambios, selecciona Marcar como visto después de revisar un archivo. Vuelve a seleccionar el control para quitar la marca. La marca se aplica a la versión del archivo que se muestra.

Si los cambios se distribuyen entre pull requests que dependen unos de otros, usa Pila en Resumen para abrir un pull request relacionado y examinar su diff, sus comentarios y sus verificaciones. Esta sección aparece cuando Revisión de código encuentra una pila de pull requests abiertos.

Leer una revisión automática en la nube

Si tienes el conector de Codex para ChatGPT, los permisos necesarios en el repositorio y las revisiones automáticas activadas, Codex puede revisar un pull request de GitHub antes de que lo abras. Los comentarios aparecen en GitHub y en Revisión de código.

Para las revisiones en la nube, no necesitas crear ni administrar un entorno en la nube. Para conocer los requisitos de conexión, la configuración del repositorio y cómo iniciar revisiones con @codex review, consulta Usar Codex en GitHub.

Contrasta los hallazgos de la revisión con el diff. Las revisiones automáticas en la nube son independientes de las que inicias en el chat del pull request.

Hacer preguntas sobre el cambio

En el chat del pull request, describe el comportamiento esperado y pídele a Codex que explique o investigue el cambio.

Selecciona Revisar con Codex para iniciar una revisión en un chat nuevo. Si tienes el pull request abierto junto a un chat existente, usa ese chat para hacer preguntas sobre el cambio.

Usa las habilidades instaladas y las fuentes conectadas para darle a Codex las pautas de revisión o los documentos de diseño de tu equipo. Pídele que resuma el cambio y explique los riesgos. Luego, verifica el contexto y el código que cita.

Por ejemplo, un pull request agrega los filtros Abiertas y Cerradas a un tablero de incidencias. Esperas que Todas siga siendo la opción predeterminada y que se muestre un estado vacío cuando ninguna incidencia coincida con el filtro:

Explícame paso a paso los cambios de este pull request. Concéntrate en el filtro
predeterminado y en lo que ocurre cuando ninguna incidencia coincide con el filtro.
Comprueba que “Todas” siga siendo la opción seleccionada de forma predeterminada.

Pide evidencia:

Muéstrame qué recorrido sigue el código cuando no hay coincidencias y qué pruebas
hay para ese caso. Explica qué cubren esas pruebas y qué falta por verificar.

Contrasta el diff y las pruebas que cita Codex con el comportamiento esperado.

Selecciona un hallazgo para ver su explicación y las líneas correspondientes en Cambios. Contrástalo con el diff más reciente, el comportamiento esperado y las pruebas antes de decidir si hace falta una corrección. Usa el chat de revisión para detener una revisión en curso.

Personalizar la revisión

Selecciona el ícono de engranaje de Instrucciones de revisión junto a Revisar con Codex. También puedes editar estas instrucciones en Configuración > Revisión de código.

Indícale a Codex qué criterios debe aplicar y en qué formato debe presentar los resultados en todas tus revisiones. Por ejemplo:

Empieza con un resumen breve. Da prioridad a los cambios de comportamiento, a la
pérdida de datos y a los casos límite para los que faltan pruebas. Para cada hallazgo,
explica qué entrada provoca el problema, qué debería ocurrir y qué ocurre en la práctica.
Usa el estilo conciso de las revisiones de nuestro equipo.

Estas instrucciones se aplican a las revisiones que inicias con Revisar con Codex en cualquier repositorio. Si cambias las instrucciones durante una revisión en curso, los cambios se aplicarán a la siguiente revisión. Usa el chat del pull request para hacer preguntas sobre un cambio en particular.

Si quieres, selecciona Cómic, Visualización o PDF para agregar una instrucción sugerida que le pida a Codex que explique el cambio en ese formato. Edita el texto según sea necesario y selecciona Guardar o Ejecutar revisión.

Compartir comentarios y darles seguimiento

Revisar un pull request en el chat no publica comentarios ni aprueba ni fusiona el pull request. Tú decides qué hallazgos compartir.

Una vez que hayas confirmado un problema, pídele a Codex que te ayude a redactar un comentario para la revisión:

Redacta un comentario siguiendo las pautas de revisión del equipo que comentamos.
Describe el comportamiento que verificamos cuando no hay coincidencias, lo que
debería ocurrir y la prueba que cubriría ese caso. Deja el comentario como borrador,
sin publicarlo.

Antes de publicar el borrador, comprueba las referencias a archivos y líneas. Deja los borradores en el chat hasta que quieras compartirlos. Al publicar un comentario en Resumen o Cambios, se envía de inmediato al proveedor del repositorio, sin esperar a que selecciones Enviar revisión.

Usa Enviar revisión para elegir entre Comentar, Aprobar o Solicitar cambios y enviar tu revisión al proveedor del repositorio. Antes de enviarla, comprueba la decisión seleccionada y el comentario de la revisión.

Si creaste el pull request, vuelve a abrirlo y pídele a Codex que atienda comentarios específicos. Examina los cambios resultantes y ejecuta las pruebas pertinentes. Antes de aprobar o fusionar el pull request, comprueba la versión más reciente, las verificaciones y los comentarios pendientes.

Revisión de código no permite editar descripciones de pull requests que tengan imágenes adjuntas. Para editar una de esas descripciones, abre el pull request en GitHub.

Continuar en un chat

Si en Resumen aparece la sección Conversaciones, selecciona uno de los chats vinculados para retomar la conversación. Allí encontrarás tus chats asociados al pull request.

En Codex, selecciona Corregir en Verificaciones dentro de un pull request abierto para adjuntar al chat las verificaciones que fallaron. Esto prepara un mensaje sin enviarlo. Revisa tu prompt o agrega uno y envíalo para pedirle a Codex que investigue. Examina los cambios resultantes y vuelve a ejecutar las pruebas pertinentes antes de subir la corrección al repositorio remoto.

La información de diagnóstico disponible depende del proveedor de las verificaciones. Si usas un servicio de integración continua de terceros, Codex puede usar el estado y la salida que el servicio comunica a GitHub.

En ChatGPT Work, sube el código que quieres revisar o dale acceso a ChatGPT mediante un complemento instalado que se conecte a la fuente. En tu prompt, especifica el pull request, la rama, el commit, los archivos y los criterios de revisión.

Revisar en la aplicación

Abre el panel de revisión para entender qué cambió, dejar comentarios en líneas específicas y decidir qué cambios preparar, revertir, incluir en un commit o subir al repositorio remoto.

Para pedirle a Codex que revise los cambios, escribe /review en el editor. Elige Revisar respecto de una rama base o Revisar cambios sin commit. Codex presenta los hallazgos por orden de prioridad sin modificar tu árbol de trabajo.

Para usar el panel de revisión, el proyecto debe estar dentro de un repositorio Git. Si tu proyecto aún no es un repositorio Git, la aplicación te pedirá que crees uno.

Escribe /review para ver las opciones de revisión predefinidas de la CLI. Codex inicia un revisor dedicado que lee el diff seleccionado y presenta, por orden de prioridad, los hallazgos sobre los que puedes actuar, sin modificar tu árbol de trabajo.

Escribe /review en el editor de la extensión para IDE. Elige Revisar respecto de una rama base o Revisar cambios sin commit. Codex presenta los hallazgos por orden de prioridad sin modificar tu árbol de trabajo.

El comando /review solo aparece cuando el proyecto abierto está dentro de un repositorio Git.

Indica en tu prompt qué pull request, rama, commit o archivos quieres examinar. Para revisar archivos locales que no estén disponibles mediante un complemento instalado que se conecte a la fuente, súbelos al chat.

Qué cambios muestra el panel

El panel de revisión refleja el estado de tu repositorio Git. Incluye los cambios que hizo Codex, los que hiciste tú y cualquier otro cambio del repositorio que aún no se haya incluido en un commit.

De forma predeterminada, el panel de revisión muestra los cambios Sin preparar. Usa Preparados para ver el índice de Git, Commit para ver un commit seleccionado, Rama para ver el diff respecto de tu rama base o Último turno para ver los cambios del turno más reciente del asistente.

Revisar varios repositorios

Cuando un proyecto local incluye varias carpetas que pertenecen a distintos repositorios Git, el panel de revisión puede mostrar los cambios de cada repositorio. Abre el selector de repositorios en el encabezado de la revisión para examinar otro repositorio y ver las líneas agregadas o eliminadas sin salir del panel actual.

Elige Último turno para ver los cambios más recientes del asistente en todos los repositorios adjuntos. En esa vista, el selector de repositorios muestra Todos los repositorios. Los demás alcances de revisión, como Sin preparar, Preparados y Rama, se aplican al repositorio que selecciones.

Elige uno de estos alcances de /review:

• Revisar respecto de una rama base identifica el ancestro común que sirve de base para la fusión y revisa el diff de tu rama.
• Revisar cambios sin commit incluye archivos preparados, sin preparar y sin seguimiento.
• Revisar un commit revisa el conjunto exacto de cambios del commit que selecciones.
• Instrucciones de revisión personalizadas centra la revisión en los criterios que indiques.

Elige uno de estos alcances de /review:

• Revisar respecto de una rama base compara tu rama actual con la rama que selecciones.
• Revisar cambios sin commit revisa los cambios de tu árbol de trabajo.

Los hallazgos de la revisión aparecen en el chat web. Pide evidencia, solicita otra revisión con un alcance más específico o pídele a ChatGPT que prepare los archivos con las correcciones.

Resultados de la revisión de código

Los hallazgos aparecen como comentarios junto a las líneas de código en el panel de revisión.

De forma predeterminada, las revisiones se ejecutan en el chat actual. En Configuración > General > Revisión de código, elige Independiente para iniciar un chat de revisión separado. Consulta la configuración para desarrolladores.

La revisión aparece como un turno en la transcripción. Configura review_model en config.toml si quieres que las revisiones usen un modelo distinto al de la sesión actual.

De forma predeterminada, la revisión se ejecuta en el chat actual. Configura chatgpt.reviewDelivery con el valor detached si quieres que /review inicie un chat de revisión separado. Consulta la referencia de configuración de la extensión para IDE.

Si le pides a ChatGPT que prepare los archivos con las correcciones, solo podrá usar las herramientas y los permisos del espacio de trabajo disponibles para ese chat.

Si le pides a Codex que aplique las correcciones que identifica, se aplica tu configuración habitual de sandbox y aprobaciones.

Navegar por el panel de revisión

• Al hacer clic en el nombre de un archivo, normalmente se abre en el editor que elegiste. Puedes elegir el editor predeterminado en la configuración para desarrolladores.
• Haz clic en el fondo del nombre del archivo para expandir o contraer el diff.
• Mantén presionada la tecla Command y haz clic en una línea para abrirla en el editor que elegiste.
• Si estás conforme con un cambio, puedes prepararlo o revertir los cambios que no quieras conservar.

Dejar comentarios en líneas específicas

Puedes agregar comentarios directamente a líneas específicas del diff. Suele ser la forma más rápida de orientar a Codex para que haga la corrección adecuada.

Para dejar un comentario en una línea:

1. Abre el panel de revisión.
2. Coloca el cursor sobre la línea que quieres comentar.
3. Selecciona el botón + que aparece.
4. Escribe tu comentario y envíalo.
5. Cuando termines de dejar comentarios, vuelve al chat y envía un mensaje.

Como cada comentario corresponde a una línea específica, Codex puede responder con más precisión que si le das una instrucción general.

Codex usa los comentarios en líneas específicas como pautas para la revisión. Después de dejar tus comentarios, envía un mensaje que indique qué quieres que haga. Por ejemplo: “Atiende los comentarios en las líneas de código y limita los cambios al mínimo”.

Preparar y revertir archivos

El panel de revisión incluye acciones de Git para que puedas ajustar el diff antes de crear un commit.

Puedes preparar cambios, quitarlos del área de preparación o revertirlos en los siguientes niveles:

• Todo el diff: usa los botones del encabezado de la revisión, como Preparar todo o Revertir todo.
• Por archivo: prepara un archivo, quítalo del área de preparación o revierte sus cambios.
• Por bloque: prepara un solo bloque de cambios, quítalo del área de preparación o reviértelo.

Prepara los cambios cuando quieras aceptar parte del trabajo y reviértelos cuando quieras descartarlos.

Cambios preparados y sin preparar

Un mismo archivo puede tener cambios preparados y sin preparar en Git. En ese caso, el archivo puede aparecer en ambas vistas del panel. Es el comportamiento normal de Git.