Lo que GitHub Copilot agrega al proceso de revisión
Las revisiones de código y las revisiones de solicitudes de incorporación de cambios son esenciales para la calidad, pero también pueden llevar mucho tiempo y ser desiguales. A menudo, los desarrolladores manejan múltiples lenguajes, formatos incoherentes y grandes diferencias de versiones mientras intentan proporcionar comentarios reflexivos. GitHub Copilot ayuda a facilitar esta carga de trabajo actuando como revisor de colaboración y asistente. Detecta problemas comunes, redacta comentarios de revisión, resume las solicitudes de incorporación de cambios e incluso resalta los riesgos de seguridad, lo que proporciona a los revisores un punto de partida claro. Con las instrucciones de revisión personalizadas, puede guiar a Copilot para ver los mismos patrones que hace, lo que garantiza la coherencia entre equipos y repositorios.
Al final de esta unidad, podrás:
- Identifique las características clave de Copilot en las revisiones de código.
- Explicar cómo las PRU desbloquean las funcionalidades de revisión avanzada.
- Reconocer diferentes formas en que la revisión de Copilot complementa y ayuda a los desarrolladores.
Características clave de Copilot en las revisiones de código
Copilot presenta varias características diseñadas para simplificar las revisiones:
Resúmenes de solicitudes de incorporación de cambios: Copilot puede redactar automáticamente descripciones de solicitudes de incorporación de cambios que incluyen un resumen claro de los cambios y una lista de archivos afectados. Esto garantiza que los revisores comiencen con el contexto, no con las estimaciones.
Correcciones de seguridad: Con la revisión de código de Copilot integrada en el análisis de código de GitHub, las vulnerabilidades se marcan en todos los lenguajes. Por ejemplo, en JavaScript, Copilot puede detectar una entrada sin sanitizar que se pasa a eval() y comentar:
"eval() con la entrada del usuario puede dar lugar a la inyección de código. Reemplácelo por un analizador seguro como JSON.parse(). Luego ofrece un parche en línea alineado con las pautas de seguridad de su repositorio.
Explicaciones de línea a línea: los revisores pueden resaltar el código y pedir a Copilot que explique la funcionalidad, lo que les ayuda a comprender rápidamente el código desconocido.
Redacción de comentarios: Copilot puede generar comentarios de revisión basados en procedimientos recomendados o directrices de equipo, haciendo que los comentarios sean claros y accionables.
Revisiones en el IDE: además de trabajar directamente en GitHub.com, Copilot también puede revisar el código dentro del IDE. Esto permite a los desarrolladores detectar y resolver problemas antes de abrir una solicitud de incorporación de cambios, acelerar el proceso y reducir el trabajo.
Descripción de cómo las PRU desbloquean las funcionalidades de revisión avanzada
Las PRU potencian estas funcionalidades avanzadas. Por ejemplo, la asignación de Copilot como revisor de solicitud de cambios utiliza un PRU cada vez que este comenta. Cuando se combina con archivos .github/copilot-instructions.md personalizados, las revisiones con tecnología de PRU se alinean con las reglas de su equipo, tanto si se centran en la legibilidad, la seguridad o el estilo.
Ejemplo:
Sin Copilot, una solicitud de modificación puede incluir comentarios imprecisos de un revisor como "Corregir aquí el problema de seguridad". Con la ayuda de Copilot + PRUs, la revisión se convierte en:
"El uso de exec() introduce una vulnerabilidad de inyección de código. Considere la posibilidad de reemplazarlo por subprocess.run() para una ejecución de comandos más segura. Aquí tienes un parche sugerido:
Además, proporciona la corrección de código en línea.
Cinco formas diferentes en que la revisión con Copilot ayuda a los desarrolladores
A continuación, revisaremos cómo La revisión de Copilot puede ayudarle a trabajar de forma más inteligente con:
- Sugerencias de revisión de código
- Revisiones de Copilot en varios idiomas
- Dar formato a los datos en solicitudes de incorporación de cambios
- Escribir resúmenes efectivos de solicitudes de cambios
- Explicación y revisión del código
Uso de sugerencias de Copilot en las revisiones de código
Al revisar una solicitud de incorporación de cambios, es posible que detecte áreas que podrían mejorarse, pero no tiene el tiempo para redactar el ejemplo o fragmento perfecto usted mismo. GitHub Copilot ayuda a llenar esa brecha sin asumir el trabajo del autor. Dentro de la vista "Archivos modificados" de la solicitud de incorporación de cambios, puede resaltar una línea o bloque de código y pedir a Copilot que sugiera mejoras o marque posibles problemas. A continuación, Copilot genera una sugerencia concreta con reconocimiento del contexto que puede copiar en el comentario de revisión, lo que hace que sus comentarios sean más claros y fáciles para que el autor actúe.
Por ejemplo, al revisar un archivo de Ruby con lógica repetida, puede resaltar las líneas pertinentes y preguntar:
"Sugerir una refactorización de Ruby más limpia para este código repetido".
Copilot propondrá una versión actualizada que siga los procedimientos recomendados comunes de Ruby. Puede pegar su recomendación (o partes de ella) en el comentario de revisión junto con su propia explicación. Esto le mantiene centrado en la calidad general y el diseño, a la vez que proporciona al autor comentarios accionables y de alto valor, sin desdibujar la línea entre revisar y codificar por él.
Revisión en varios idiomas
Al solicitar una revisión de código, Copilot puede resaltar automáticamente las áreas que no siguen los procedimientos recomendados ni las directrices del equipo.
Copilot generará rápidamente mejoras que se alinean con las convenciones del lenguaje, lo que le permite proporcionar comentarios de revisión más sólidos y precisos incluso fuera de su área principal de experiencia.
Dar formato a los datos de las solicitudes de incorporación de cambios
Las solicitudes de incorporación de cambios son mucho más claras cuando incluyen contexto con formato correcto, como métricas, capturas de pantalla o resultados de pruebas. Sin embargo, los equipos a menudo olvidan dar formato a este contenido de forma coherente. GitHub Copilot puede actuar como un segundo conjunto de ojos durante la revisión del código, marcando automáticamente las tablas con formato deficiente en una descripción de la solicitud de incorporación de cambios y proponiendo una versión más limpia que se alinea con las directrices de estilo de su empresa.
Ejemplo: un desarrollador envía una solicitud de incorporación de cambios con la siguiente tabla de tiempos de carga de páginas. Es difícil de leer y no sigue la guía de estilo de Markdown del equipo.
| Ejecución de pruebas | TiempoDeCargaPrevio | LoadTimeAfter |
|---|---|---|
| 1.3 | 1.2 | |
| 1.2 | 1.1 | |
| 1.1 | 0.885 | |
| 1.3 | 1.3 | |
| 1.2 | 0.918 | |
| Average | 1,22 | 1.0806 |
Durante la revisión, Copilot publica un comentario:
"Esta tabla no sigue las directrices de Markdown del repositorio. Esta es una versión limpia basada en la guía de estilo de su empresa".
Además, incluye una versión corregida lista para pegarla en la descripción de la solicitud de cambios:
| Ejecución de pruebas | Tiempo de carga previo (segundos) | Tiempo de carga después de actualizaciones (segundos) |
|---|---|---|
| 1 | 1.3 | 1.2 |
| 2 | 1.2 | 1.1 |
| 3 | 1.1 | 0.885 |
| 4 | 1.3 | 1.3 |
| 5 | 1.2 | 0.918 |
| Promedio | 1.22 | 1.0806 |
El revisor puede aceptar la sugerencia de Copilot con un solo clic, asegurándose de que la solicitud de cambios sigue el estilo de la empresa sin dedicar tiempo a cambiar el formato.
Esto muestra que Copilot actúa como revisor automático (no un agente de codificación): ve la tabla sin formato, aplica las directrices de la empresa de .github/copilot-instructions.md y proporciona una versión corregida en línea.
Escribir resúmenes efectivos de solicitudes de cambios
Escribir descripciones de PR suele ser el último paso del proceso y puede sentirse como un obstáculo. Copilot facilita esto. Desde el editor de descripción de PR, puede usar el icono de Copilot para generar un resumen o un borrador de esquema. Incluso si realiza modificaciones, tener un punto de partida bien estructurado ahorra tiempo y garantiza que los revisores tengan la información que necesitan.
Explicación y revisión del código
A veces quizás no estés familiarizado con el código en un pull request. En lugar de tener dificultades con ello, puede pedir a Copilot que explique los cambios. Copilot también puede ejecutar una revisión inicial de tus propios PRs antes de solicitar comentarios de tus compañeros de equipo. Esto ayuda a detectar problemas más pequeños, valida los procedimientos recomendados y proporciona más confianza en la calidad del envío.
Ahora sabe lo que Copilot es capaz de cuando se trata de revisiones de código. A continuación, veamos cómo usar las revisiones de Copilot directamente en GitHub.com.