Revisión de código con Amazon Q Developer en GitHub - Amazon Q Developer
Requisitos previosIniciación de revisiones de código para las solicitudes de extracción de GitHubIniciación de revisiones de código dentro de las solicitudes de extracción de GitHub

Revisión de código con Amazon Q Developer en GitHub

nota

Amazon Q Developer para GitHub está en versión de vista previa y sujeto a cambios.

Amazon Q Developer permite realizar revisiones de código automatizadas desde GitHub. Cuando se crea una nueva solicitud de extracción o se vuelve a abrir una solicitud de extracción cerrada, Amazon Q Developer realiza automáticamente una revisión del código y proporciona comentarios sobre la calidad del código, los posibles problemas y los resultados de seguridad. Cada revisión incluye un resumen de la revisión del código con los resultados subprocesados. Amazon Q Developer también genera correcciones para los problemas identificados, que puede revisar y confirmar con la solicitud de extracción. Puede usar el comando /q en los comentarios de las solicitudes de extracción para hacer preguntas e interactuar en relación con los resultados de la revisión del código. Las revisiones automáticas del código no se activan con las confirmaciones posteriores realizadas dentro de una solicitud de extracción existente.

También puede iniciar las revisiones de código dentro de las solicitudes de extracción con el comando de barra inclinada /q review. El comando de barra inclinada se puede añadir a un nuevo comentario de solicitud de extracción, lo que inicia una nueva revisión de código de la solicitud de extracción en su estado actual, incluidos comentarios y nuevas confirmaciones. Para obtener más información, consulte Iniciación de revisiones de código dentro de las solicitudes de extracción de GitHub.

Puede hacer que Amazon Q Developer realice una revisión de código para una cantidad limitada de líneas al mes. Puede aumentar el uso gratuito en cualquier momento registrando la instalación de la aplicación Amazon Q Developer en su cuenta de AWS. Para obtener más información, consulte Aumento de los límites de uso y los detalles de configuración en la consola de Amazon Q Developer.

nota

Si la función de revisión de código estaba deshabilitada anteriormente, debe estar habilitada en la consola de Amazon Q Developer antes de poder aplicar la etiqueta en GitHub. Para obtener más información, consulte Edición de características de Amazon Q Developer en GitHub.

Requisitos previos

Antes de poder iniciar las revisiones de código con Amazon Q Developer, necesitas los permisos adecuados para el repositorio de GitHub de destino. Los roles de repositorio compatibles son escritura, mantenimiento o administración. Los usuarios con funciones de lectura o de clasificación, así como los miembros sin un rol, no pueden iniciar revisiones de código con Amazon Q Developer.

Los usuarios de GitHub con la función de clasificación pueden seguir revisando las solicitudes de extracción en un repositorio. Cualquier usuario, independientemente de su rol, puede revisar las solicitudes de extracción en los repositorios públicos.

Para obtener más información, consulte Repository roles for organizations y About pre-defined organization roles en la Documentación de GitHub.

Iniciación de revisiones de código para las solicitudes de extracción de GitHub

Cuando abre una nueva solicitud de extracción o vuelve a abrir una que ya estaba cerrada, Amazon Q Developer realiza automáticamente una revisión del código y envía comentarios sobre la calidad del código, los posibles problemas y los resultados más importantes.

Cómo usar Amazon Q Developer para revisiones de código y aplicación de correcciones

Antes de iniciar una revisión, puede personalizar una revisión de la calidad del código definiendo estándares de codificación personalizados en archivos Markdown sencillos del directorio project-root/.amazonq/rules. Amazon Q sigue automáticamente sus directrices, lo que garantiza una calidad de código uniforme en todo el proyecto. Para obtener más información, consulte Creación de reglas de proyecto para Amazon Q Developer en plataformas de terceros.

  1. Si es necesario, inicie sesión en su cuenta de GitHub usando sus credenciales de GitHub.

  2. Navegue hasta la organización de GitHub y, a continuación, navegue hasta el repositorio en el que desee realizar una revisión de código con Amazon Q Developer.

  3. Cree una nueva solicitud de extracción para los cambios realizados en el código fuente. Para obtener más información, consulte Creating a pull request en la Documentación de GitHub.

    Al crear una nueva solicitud de extracción, Amazon Q Developer inicia automáticamente una revisión del código para detectar posibles problemas. Una vez que Amazon Q Developer completa la revisión, proporciona un resumen de la revisión del código. Cada resultado aparece como un comentario enlazado debajo del resumen, junto con sugerencias de correcciones que puede confirmar en la solicitud de extracción.

  4. (Opcional) Realice preguntas sobre resultados específicos. En la solicitud de extracción, navegue hasta Añadir un comentario y, en el campo de introducción de texto del comentario, introduzca /q seguido de la pregunta (por ejemplo, “/q explain the importance of this finding”).

  5. Revise los cambios de código propuestos por Amazon Q Developer, elija Confirmar sugerencia y, a continuación, elija Confirmar los cambios para actualizar la solicitud de extracción.

  6. Si está satisfecho con las correcciones de código sugeridas, puede combinar la solicitud de extracción para aplicar los cambios de código sugeridos por Amazon Q Developer. Para obtener más información, consulte Merging a pull request en la Documentación de GitHub.

Iniciación de revisiones de código dentro de las solicitudes de extracción de GitHub

Tras una revisión automática del código realizada por Amazon Q Developer para una solicitud de extracción de GitHub nueva o reabierta, puede iniciar revisiones de código adicionales para iterar sobre el código mediante el comando de barra inclinada /q review. La revisión del código se realiza en toda la vista de diferencias de la solicitud de extracción.

nota

Solo puede iniciar una revisión de código dentro de una solicitud de extracción con un comentario nuevo. El comando de barra inclinada /q review no funcionará en una cadena de comentarios existente.

Cómo utilizar revisiones de código iniciadas en una solicitud de extracción

  1. Si es necesario, inicie sesión en su cuenta de GitHub usando sus credenciales de GitHub.

  2. Navegue hasta su organización de GitHub y, a continuación, navegue hasta la solicitud de extracción en la que desee realizar una revisión del código con Amazon Q Developer. Para obtener más información, consulte About pull requests.

  3. En la solicitud de extracción, navegue hasta Añadir un comentario y, en el campo de entrada de texto del comentario, indique /q review.

  4. Elija Comentar para iniciar la revisión del código.

    Amazon Q Developer puede tardar unos minutos en completar el análisis del código de la solicitud de extracción. Después de que Amazon Q Developer termine de analizar, proporciona un resumen de la revisión del código. Cada resultado aparece como un comentario enlazado debajo del resumen, junto con los cambios propuestos que puede elegir para confirmar y actualizar la solicitud de extracción.

  5. (Opcional) Realice preguntas sobre resultados específicos. En la solicitud de extracción, navegue hasta Añadir un comentario y, en el campo de introducción de texto del comentario, introduzca /q seguido de la pregunta (por ejemplo, “/q explain the importance of this finding”).

  6. Si está satisfecho con las correcciones de código sugeridas, puede combinar la solicitud de extracción para aplicar los cambios de código sugeridos por Amazon Q Developer. Para obtener más información, consulte Merging a pull request en la Documentación de GitHub.