Revisar código com o Amazon Q Developer no GitHub - Amazon Q Developer
Pré-requisitosIniciar revisões de código para solicitações pull do GitHubIniciar revisões de código em solicitações pull do GitHub

Revisar código com o Amazon Q Developer no GitHub

nota

O Amazon Q Developer para GitHub está na versão prévia e está sujeito a alterações.

O Amazon Q Developer permite revisões automatizadas de código dentro do GitHub. Quando você cria uma solicitação pull ou reabre uma solicitação pull fechada, o Amazon Q Developer realiza automaticamente uma revisão de código e fornece feedback sobre a qualidade do código, possíveis problemas e descobertas de alta severidade. Cada revisão inclui um resumo da revisão de código com descobertas agrupadas. O Amazon Q Developer também gera correções para os problemas identificados, que você pode revisar e selecionar se deseja incluir na solicitação pull. Você pode usar o comando /q nos comentários da solicitação pull para fazer perguntas e interagir com relação às descobertas da revisão de código. As revisões automáticas de código não são acionadas por confirmações subsequentes feitas em uma solicitação pull existente.

Você também pode iniciar revisões de código em solicitações pull com o comando de barra /q review. O comando de barra pode ser adicionado a um novo comentário da solicitação pull, iniciando uma nova revisão de código da solicitação pull em seu estado atual, incluindo quaisquer comentários e novas confirmações. Para obter mais informações, consulte Iniciar revisões de código em solicitações pull do GitHub.

Você pode fazer com que o Amazon Q Developer realize uma revisão de código para uma quantidade limitada de linhas por mês. Você pode aumentar seu uso gratuito a qualquer momento registrando a instalação da aplicação do Amazon Q Developer em sua conta da AWS. Para obter mais informações, consulte Aumentar os limites de uso e configurar detalhes no console do Amazon Q Developer.

nota

Se a capacidade de revisão de código foi desabilitada anteriormente, ela deve ser habilitada no console do Amazon Q Developer antes que você possa aplicar o rótulo no GitHub. Para obter mais informações, consulte Editar recursos para o Amazon Q Developer no GitHub.

Pré-requisitos

Antes de iniciar revisões de código com o Amazon Q Developer, você precisará das permissões apropriadas para o repositório de destino do GitHub. As funções de repositório compatíveis são Gravação, Manutenção ou Administração. Usuários com as funções Leitura ou Triagem, bem como membros sem função, não poderão iniciar revisões de código com o Amazon Q Developer.

Usuários do GitHub com a função Triagem ainda poderão revisar solicitações pull em um repositório. Qualquer usuário, independentemente da função, poderá revisar solicitações pull em repositórios públicos.

Para obter mais informações, consulte Repository roles for organizations e About pre-defined organization roles na documentação do GitHub.

Iniciar revisões de código para solicitações pull do GitHub

Quando você abre uma nova solicitação pull ou reabre uma anteriormente fechada, o Amazon Q Developer executa automaticamente uma revisão de código e fornece feedback sobre a qualidade do código, possíveis problemas e descobertas críticas.

Como usar o Amazon Q Developer para revisões de código e aplicação de correções

Antes de iniciar uma revisão, você pode personalizar uma revisão de qualidade de código definindo padrões de codificação personalizados em arquivos Markdown simples no diretório project-root/.amazonq/rules. O Amazon Q segue automaticamente suas diretrizes, garantindo uma qualidade de código consistente em todo o seu projeto. Para obter mais informações, consulte Criar regras de projeto para o Amazon Q Developer em plataformas de terceiros.

  1. Se necessário, faça login na sua conta do GitHub usando suas credenciais do GitHub.

  2. Navegue até sua organização do GitHub e, em seguida, navegue até o repositório no qual deseja realizar uma revisão de código com o Amazon Q Developer.

  3. Crie uma nova solicitação pull para as alterações feitas em seu código-fonte. Para obter mais informações, consulte Creating a pull request na documentação do GitHub.

    Quando você cria uma solicitação pull, o Amazon Q Developer inicia automaticamente uma revisão de código para encontrar possíveis problemas. Depois que o Amazon Q Developer conclui a revisão, ele fornece um resumo da revisão de código. Cada descoberta aparece como um comentário agrupado abaixo do resumo, com correções sugeridas que você pode aplicar à solicitação pull.

  4. (Opcional) Faça perguntas sobre descobertas específicas. Na solicitação pull, navegue até Adicionar um comentário e, no campo de entrada de texto do comentário, digite /q seguido pela sua pergunta (por exemplo, “/q explain the importance of this finding”).

  5. Revise as alterações de código propostas pelo Amazon Q Developer, clique em Confirmar sugestão e, em seguida, Confirmar alterações para atualizar a solicitação pull.

  6. Se as correções de código sugeridas forem satisfatórias, você poderá mesclar a solicitação pull para aplicar as alterações de código sugeridas pelo Amazon Q Developer. Para obter mais informações, consulte Merging a pull request na documentação do GitHub.

Iniciar revisões de código em solicitações pull do GitHub

Após uma revisão automática de código realizada pelo Amazon Q Developer para uma solicitação pull do GitHub nova ou reaberta, você pode iniciar revisões de código adicionais para iterar seu código usando o comando de barra /q review. A revisão de código é realizada em toda a comparação da solicitação pull.

nota

Você só pode iniciar uma revisão de código em uma solicitação pull com um novo comentário. O comando de barra /q review não funcionará em uma thread de comentários existente.

Como iniciar revisões de código em uma solicitação pull

  1. Se necessário, faça login na sua conta do GitHub usando suas credenciais do GitHub.

  2. Navegue até sua organização do GitHub e, em seguida, navegue até a solicitação pull na qual você deseja realizar uma revisão de código com o Amazon Q Developer. Para obter mais informações, consulte About pull requests.

  3. Na solicitação pull, navegue até Adicionar um comentário e, no campo de entrada de texto do comentário, insira /q review.

  4. Selecione Comentar para iniciar a revisão de código.

    Pode levar alguns minutos para que o Amazon Q Developer conclua a análise da solicitação pull. Depois que o Amazon Q Developer terminar a análise, ele fornecerá um resumo da revisão de código. Cada descoberta aparece como um comentário agrupado abaixo do resumo, com as alterações propostas que você pode escolher para aplicar e atualizar a solicitação pull.

  5. (Opcional) Faça perguntas sobre descobertas específicas. Na solicitação pull, navegue até Adicionar um comentário e, no campo de entrada de texto do comentário, digite /q seguido pela sua pergunta (por exemplo, “/q explain the importance of this finding”).

  6. Se as correções de código sugeridas forem satisfatórias, você poderá mesclar a solicitação pull para aplicar as alterações de código sugeridas pelo Amazon Q Developer. Para obter mais informações, consulte Merging a pull request na documentação do GitHub.