Tutorial: Usar os recursos de IA generativa do CodeCatalyst para acelerar seu trabalho de desenvolvimento - Amazon CodeCatalyst
Pré-requisitosUsar o Amazon Q para escolher um esquema ao criar um projeto ou adicionar funcionalidadeAdicionar um resumo gerado automaticamente ao criar uma solicitação pullCriar um resumo dos comentários deixados sobre alterações de código em uma solicitação pullCriar um problema e atribuir ao Amazon QCriar um problema e ter tarefas recomendadas pelo Amazon Q para eleLimpar os recursos

Tutorial: Usar os recursos de IA generativa do CodeCatalyst para acelerar seu trabalho de desenvolvimento

Se você tem um projeto e um repositório de origem no Amazon CodeCatalyst em um espaço onde recursos de IA generativa estão habilitados, você pode usar esses recursos para ajudar a acelerar o desenvolvimento de software. Os desenvolvedores geralmente têm mais tarefas a fazer do que tempo para realizá-las. Eles geralmente não se dão ao trabalho de explicar as alterações de código aos colegas de equipe ao criar solicitações pull para análise dessas alterações, esperando que outros usuários achem as alterações autoexplicativas. Os criadores e revisores da solicitação pull também não têm tempo para encontrar e ler todos os comentários em uma solicitação pull minuciosamente, especialmente se a solicitação pull tiver várias revisões. O CodeCatalyst se integra ao agente do Amazon Q Developer para desenvolvimento de software para fornecer recursos de IA generativa que podem ajudar os membros da equipe a realizar as tarefas mais rapidamente e aumentar o tempo necessário para se concentrar nas partes mais importantes do trabalho.

O Amazon Q Developer é um assistente conversacional habilitado por IA generativa que pode ajudar você a entender, criar, ampliar e operar aplicações da AWS. Para acelerar o desenvolvimento na AWS, o modelo que impulsiona o Amazon Q foi aprimorado com conteúdo de alta qualidade da AWS para fornecer respostas mais completas, acionáveis e referenciadas. Para ter mais informações, consulte What is Amazon Q Developer no Guia do usuário do Amazon Q Developer.

nota

Tecnologia da Amazon Bedrock: a AWS implementa a detecção automática de abusos. Como os recursos Escrever descrição para mim, Criar resumo do conteúdo, Recomendar tarefas, Usar o Amazon Q para criar ou adicionar recursos a um projeto e Atribuir problemas ao Amazon Q com os recursos do agente do Amazon Q Developer para desenvolvimento de software são baseados no Amazon Bedrock, os usuários podem aproveitar ao máximo os controles implementados no Amazon Bedrock para reforçar a segurança, a proteção e o uso responsável de inteligência artificial.

Neste tutorial, você aprenderá a usar os recursos de IA generativa no CodeCatalyst para criar projetos com esquemas, bem como adicionar esquemas a projetos existentes. Além disso, você aprenderá a resumir as alterações entre as ramificações ao criar solicitações pull e a resumir os comentários deixados em uma solicitação pull. Você também aprenderá a criar problemas com suas ideias para alterações ou melhorias no código e atribuí-los ao Amazon Q. Como parte do trabalho com problemas atribuídos ao Amazon Q, você aprenderá como permitir que o Amazon Q sugira tarefas e como atribuir e trabalhar em qualquer tarefa criada como parte do trabalho em um problema.

Pré-requisitos

Para trabalhar com os recursos do CodeCatalyst neste tutorial, você deve primeiro concluir e ter acesso aos seguintes recursos:

  • Você tem um ID do builder AWS ou uma identidade de autenticação única (SSO) para entrar no CodeCatalyst.

  • Você está em um espaço que tem recursos de IA generativa ativados. Para ter mais informações, consulte Gerenciar recursos de IA generativa.

  • Você tem o perfil de colaborador ou administrador do projeto em um projeto nesse espaço.

  • A menos que você esteja criando um projeto com IA generativa, seu projeto existente tem pelo menos um repositório de origem configurado. Não há suporte a repositórios vinculados.

  • Ao atribuir problemas para ter uma solução inicial criada pela IA generativa, o projeto não pode ser configurado com a extensão do software Jira. A extensão não é compatível para esse recurso.

Para obter mais informações, consulte Criar um espaço, Acompanhar e organizar o trabalho com problemas no CodeCatalyst, Adicionar funcionalidade a projetos com extensões no CodeCatalyst e Concessão de acesso com perfis de usuário.

Este tutorial é baseado em um projeto criado usando o esquema de aplicação web moderna de três níveis com Python. Se você usar um projeto criado com um esquema diferente, ainda poderá seguir as etapas, mas algumas especificidades podem variar, como código de exemplo e linguagem.

Usar o Amazon Q para escolher um esquema ao criar um projeto ou adicionar funcionalidade

Como desenvolvedor do projeto, você pode colaborar com o Amazon Q, um assistente de IA generativa, ao criar novos projetos ou adicionar componentes a projetos existentes. Você pode fornecer ao Amazon Q os requisitos do projeto interagindo com ele em uma interface semelhante a um bate-papo. Com base em seus requisitos, o Amazon Q sugere um esquema e também descreve os requisitos que não podem ser atendidos. Se o seu espaço tiver esquemas personalizados, o Amazon Q aprenderá e incluirá esses esquemas nas recomendações também. Você pode continuar com a sugestão do Amazon Q se estiver satisfeito, e ele criará os recursos necessários, como um repositório de origem com código para seu requisito. O Amazon Q também cria problemas para requisitos que não podem ser satisfeitos com um esquema. Para saber mais sobre os esquemas do CodeCatalyst disponíveis, consulte Criação de um projeto abrangente com esquemas do CodeCatalyst. Para saber mais sobre o uso do Amazon Q com esquemas, consulte Práticas recomendadas ao usar o Amazon Q para criar projetos ou adicionar funcionalidades com esquemas.

Para criar um projeto com o Amazon Q

  1. Abra o console do CodeCatalyst em https://codecatalyst.aws/.

  2. No console do CodeCatalyst, acesse o espaço onde você deseja criar um esquema.

  3. No painel do espaço, selecione Criar com Amazon Q.

  4. No campo de entrada de texto do prompt do Amazon Q, forneça instruções escrevendo uma breve descrição sobre o projeto que você deseja criar. Por exemplo, “I want to create a project in Python that has a presentation layer responsible for how the data is presented, an application layer that contains the core logic and functionality of the application, and a data layer that manages the storage and retrieval of the data.”

    (Opcional) Em Experimentar exemplos, você pode usar um prompt pré-escrito escolhendo um esquema. Por exemplo, se você escolher a aplicação React, o seguinte prompt será fornecido: “I want to create a project in Python that has a presentation layer responsible for how the data is presented, an application layer that contains the core logic and functionality of the application, and a data layer that manages the storage and retrieval of the data. I also want to add authentication and authorization mechanisms for security and allowable actions.”

  5. Selecione Enviar para enviar suas instruções para o Amazon Q. O assistente de IA generativa fornece uma sugestão e descreve os requisitos que não podem ser atendidos pelo esquema. Por exemplo, o Amazon Q pode sugerir o seguinte com base em seus critérios:

    I recommend using the Modern three-tier web application blueprint based on 
                    your requirements. Blueprints are dynamic and can always be updated and edited later.

Modern three-tier web application
By Amazon Web Services

This blueprint creates a Mythical Mysfits 3-tier web application with a modular presentation, application, and data layers. 
The application leverages containers, infrastructure as code (IaC), continuous integration and continuous delivery (CI/CD), 
and serverless code functions.

Version: 0.1.163

View details

The following requirements could not be met so I will create issues for you.
• Add authentication and authorization mechanisms for security and allowable actions.

  6. (Opcional) Para visualizar os detalhes do esquema sugerido, selecione Exibir detalhes.

  7. Execute um destes procedimentos:

    1. Selecione Sim, usar esse esquema se estiver satisfeito com a sugestão.

    2. Selecione Editar prompt se quiser modificar o prompt.

    3. Selecione Recomeçar se quiser limpar completamente o prompt.

  8. Execute um destes procedimentos:

    1. Selecione Configurar se quiser configurar o esquema sugerido. Você também poderá configurar o esquema mais tarde.

    2. Selecione Ignorar se você não quiser modificar as configurações do esquema no momento.

  9. Se você optar por configurar o esquema, selecione Continuar depois de modificar os recursos do projeto.

  10. Quando solicitado, insira o nome que você deseja atribuir ao seu projeto e os nomes dos recursos associados. O nome deve ser exclusivo em seu espaço.

  11. Selecione Criar projeto para criar um projeto com o esquema. O Amazon Q cria recursos usando o esquema. Por exemplo, se você criar um projeto com o esquema de aplicação de página única, um repositório de origem para códigos e fluxos de trabalho relevantes para CI/CD será criado.

  12. (Opcional) Por padrão, o Amazon Q também cria problemas para os requisitos que não são atendidos por um esquema. É possível escolher para quais itens você não deseja criar problemas. Depois de optar por permitir que o Amazon Q crie problemas, você também pode atribuir um problema ao Amazon Q. Ele analisará o problema no contexto dos repositórios de origem fornecidos, mostrando um resumo dos arquivos de origem e códigos relevantes. Para ter mais informações, consulte Descoberta e visualização de problemas, Criar um problema e atribuir ao Amazon Q e Práticas recomendadas ao criar e trabalhar com problemas atribuídos ao Amazon Q.

Depois de criar um projeto com o Amazon Q, você também pode usar o Amazon Q para adicionar novos componentes, pois ele sugere esquemas do CodeCatalyst com base em seus requisitos.

Para adicionar um esquema com o Amazon Q

  1. Abra o console do CodeCatalyst em https://codecatalyst.aws/.

  2. No console do CodeCatalyst, navegue até o projeto onde você deseja adicionar um esquema.

  3. Selecione Adicionar com Amazon Q.

  4. No campo de entrada de texto do prompt do Amazon Q, forneça instruções escrevendo uma breve descrição sobre o projeto que você deseja criar. Por exemplo, “I want to create a project in Python that has a presentation layer responsible for how the data is presented, an application layer that contains the core logic and functionality of the application, and a data layer that manages the storage and retrieval of the data.”

    (Opcional) Em Experimentar exemplos, você pode usar um prompt pré-escrito escolhendo um esquema. Por exemplo, se você escolher a aplicação React, o seguinte prompt será fornecido: “I want to create a project in Python that has a presentation layer responsible for how the data is presented, an application layer that contains the core logic and functionality of the application, and a data layer that manages the storage and retrieval of the data. I also want to add authentication and authorization mechanisms for security and allowable actions.”

  5. Selecione Enviar para enviar suas instruções para o Amazon Q. O assistente de IA generativa fornece uma sugestão e descreve os requisitos que não podem ser atendidos pelo esquema. Por exemplo, o Amazon Q pode sugerir o seguinte com base em seus critérios:

    I recommend using the Single-page application blueprint based on your requirements. Blueprints are dynamic and can always be updated and edited later.

Single-page application
By Amazon Web Services

This blueprint creates a SPA (single-page application) using React, Vue, or Angular frameworks and deploys to AWS Amplify Hosting.

Version: 0.2.15
View details

The following requirements could not be met so I will create issues for you.
• The application should have reusable UI components
• The application should support for client-side routing
• The application may require server-side rendering for improved performance and SEO

  6. (Opcional) Para visualizar os detalhes do esquema sugerido, selecione Exibir detalhes.

  7. Execute um destes procedimentos:

    1. Selecione Sim, usar esse esquema se estiver satisfeito com a sugestão.

    2. Selecione Editar prompt se quiser modificar o prompt.

    3. Selecione Recomeçar se quiser limpar completamente o prompt.

  8. Execute um destes procedimentos:

    1. Selecione Configurar se quiser configurar o esquema sugerido. Você também poderá configurar o esquema mais tarde.

    2. Selecione Ignorar se você não quiser modificar as configurações do esquema no momento.

  9. Se você optar por configurar o esquema, selecione Continuar depois de modificar os recursos do projeto.

  10. Selecione Adicionar ao projeto para adicionar recursos a um projeto com o esquema. O Amazon Q cria recursos usando o esquema. Por exemplo, se você adicionar a um projeto com o esquema de aplicação de página única, um repositório de origem para códigos e fluxos de trabalho relevantes para CI/CD será criado.

  11. (Opcional) Por padrão, o Amazon Q também cria problemas para os requisitos que não são atendidos por um esquema. É possível escolher para quais itens você não deseja criar problemas. Depois de optar por permitir que o Amazon Q crie problemas, você também pode atribuir um problema ao Amazon Q. Ele analisará o problema no contexto dos repositórios de origem fornecidos, mostrando um resumo dos arquivos de origem e códigos relevantes. Para ter mais informações, consulte Criar um problema e atribuir ao Amazon Q e Práticas recomendadas ao criar e trabalhar com problemas atribuídos ao Amazon Q.

Criar um resumo das alterações de código entre as ramificações ao criar uma solicitação pull

Uma solicitação pull é a principal maneira para você e outros membros do projeto revisarem, comentarem e mesclarem alterações de código de uma ramificação para outra. Você pode usar solicitações pull para revisar alterações de código de maneira colaborativa em caso de alterações ou correções relativamente pequenas, adições significativas de recursos ou novas versões do seu software lançado. Resumir as alterações no código e a intenção por trás das mudanças como parte da descrição da solicitação pull é útil para outras pessoas que revisarão o código e também ajuda a entender o histórico das alterações no código ao longo do tempo. No entanto, os desenvolvedores geralmente confiam no código para se explicar ou fornecer detalhes ambíguos, em vez de descrever alterações com detalhes suficientes para que os revisores entendam o que estão revisando ou qual era a intenção por trás das alterações no código.

Você pode usar o recurso Escrever descrição para mim ao criar solicitações pull para que o Amazon Q crie uma descrição das alterações contidas em uma solicitação pull. Quando você escolhe essa opção, o Amazon Q analisa as diferenças entre a ramificação de origem que contém as alterações de código e a ramificação de destino na qual você deseja mesclar essas alterações. Em seguida, ele cria um resumo dessas alterações, bem como sua melhor interpretação da intenção e do efeito dessas alterações.

nota

Esse recurso não funciona com submódulos do Git. Ele não resumirá nenhuma alteração em um submódulo do Git que faz parte da solicitação pull.

Esse recurso não está disponível para solicitações pull em repositórios vinculados.

Você pode experimentar esse recurso com qualquer solicitação pull que criar, mas neste tutorial, vamos testá-lo fazendo algumas alterações simples no código contido em um projeto criado em um esquema de aplicação web moderna de três níveis baseado em Python.

dica

Se você estiver usando um projeto criado com um esquema diferente ou com seu próprio código, ainda poderá seguir este tutorial, mas os exemplos deste tutorial não corresponderão ao código do seu projeto. Em vez do exemplo sugerido abaixo, faça alterações simples no código do projeto em uma ramificação e, depois, crie uma solicitação pull para testar o recurso, conforme mostrado nas etapas a seguir.

Primeiro, você criará uma ramificação no repositório de origem. Em seguida, você fará uma rápida alteração no código de um arquivo nessa ramificação usando o editor de texto no console. Depois, você criará uma solicitação pull e usará o recurso Escrever descrição para mim para resumir as alterações feitas.

Como criar uma ramificação (console)

  1. No console do CodeCatalyst, navegue até o projeto onde o repositório de origem reside.

  2. Selecione o nome do repositório na lista de repositórios de origem do projeto. No painel de navegação, também é possível selecionar Código e escolher Repositórios de origem.

  3. Selecione o repositório onde você deseja criar uma ramificação.

  4. Na página de visão geral do repositório, selecione Mais e, depois, escolha Criar ramificação.

  5. Insira um nome para a ramificação.

  6. Selecione uma ramificação a partir da qual criar a ramificação e, depois, selecione Criar.

Depois de ter uma ramificação, edite um arquivo nessa ramificação com uma simples alteração. Neste exemplo, você editará o arquivo test_endpoint.py para alterar o número de novas tentativas de testes de 3 para 5.

dica

Você também pode optar por criar ou usar um Ambiente de Desenvolvimento para fazer essa alteração no código. Para ter mais informações, consulte Criar um Ambiente de Desenvolvimento.

Para editar o arquivo test_endpoint.py no console

  1. Na página de visão geral do repositório de origem mysfits, escolha o menu suspenso da ramificação e escolha a ramificação que você criou no procedimento anterior.

  2. Em Arquivos, navegue até o arquivo que você deseja editar. Por exemplo, para editar o arquivo test_endpoint.py, expanda os testes, expanda integ e escolha test_endpoint.py.

  3. Selecione a opção Editar.

  4. Na linha 7, altere o número de vezes que todos os testes serão repetidos em:

    def test_list_all(retry=3):

    para:

    def test_list_all(retry=5):

  5. Selecione Confirmar e confirme as alterações na ramificação.

Agora que você tem uma ramificação com uma alteração, pode criar uma solicitação pull.

Crie uma solicitação pull com um resumo das alterações

  1. Na página de visão geral do repositório, selecione Mais e, depois, selecione Criar solicitação pull.

  2. Em Ramificação de destino, selecione a ramificação na qual mesclar o código depois que ele for revisado.

    dica

    Escolha a ramificação com base na qual você criou a ramificação no procedimento anterior para ver a demonstração mais simples desse recurso. Por exemplo, se você criou sua ramificação a partir da ramificação padrão do repositório, escolha essa ramificação como a ramificação de destino da solicitação pull.

  3. Em Ramificação de origem, escolha a ramificação que contém as alterações que você acabou de confirmar no arquivo test_endpoint.py.

  4. Em Título da solicitação pull, insira um título que ajude outros usuários a entender o que precisa ser revisado e por quê.

  5. Em Descrição da solicitação pull, selecione Escrever descrição para mim para que o Amazon Q crie uma descrição das alterações contidas na solicitação pull.

  6. Um resumo das alterações é exibido. Revise o texto sugerido e selecione Aceitar e adicionar à descrição.

  7. Se desejar, modifique o resumo para refletir melhor as alterações feitas no código. Você também pode optar por adicionar revisores ou vincular problemas a essa solicitação pull. Quando terminar de fazer as alterações adicionais desejadas, selecione Criar.

Criar um resumo dos comentários deixados sobre alterações de código em uma solicitação pull

Quando os usuários revisam uma solicitação pull, eles geralmente deixam vários comentários sobre as alterações nessa solicitação pull. Se houver muitos comentários de muitos revisores, pode ser difícil escolher temas comuns nos comentários ou até mesmo ter certeza de que você revisou todos os comentários em todas as revisões. Você pode usar o recurso Criar resumo de comentários para que o Amazon Q analise todos os comentários deixados sobre alterações de código em uma solicitação pull e crie um resumo desses comentários.

nota

Os resumos dos comentários são temporários. Se você atualizar uma solicitação pull, o resumo desaparecerá. Os resumos de conteúdo não incluem comentários sobre a solicitação pull geral, apenas comentários deixados sobre diferenças no código nas revisões da solicitação pull.

Esse recurso não funciona com nenhum comentário deixado sobre alterações de código nos submódulos do Git.

Esse recurso não está disponível para solicitações pull em repositórios vinculados.

Como criar um resumo dos comentários em uma solicitação pull

  1. Navegue até a solicitação pull criada no procedimento anterior.

    dica

    Se preferir, você pode usar qualquer solicitação pull aberta em seu projeto. Na barra de navegação, selecione Código, selecione Solicitações pull e escolha qualquer solicitação pull aberta.

  2. Adicione alguns comentários à solicitação pull em Alterações se a solicitação pull ainda não tiver comentários.

  3. Em Visão geral, selecione Criar resumo de comentários. Quando concluída, a seção Resumo do comentário se expande.

  4. Analise o resumo dos comentários deixados sobre as alterações no código nas revisões da solicitação pull e compare-o com os comentários na solicitação pull.

Criar um problema e atribuir ao Amazon Q

As equipes de desenvolvimento criam problemas para monitorar e gerenciar o trabalho, mas, às vezes, um problema persiste porque não está claro quem deve trabalhar nele, o problema requer pesquisa em uma parte específica da base de código ou outro trabalho urgente deve ser realizado primeiro. O CodeCatalyst inclui a integração com o agente do Amazon Q Developer para desenvolvimento de software. Você pode atribuir problemas a um assistente de IA generativa chamado Amazon Q, que pode analisar um problema com base no título e na descrição. Se você atribuir o problema ao Amazon Q, ele tentará criar um rascunho de solução para você avaliar. Isso pode ajudar você e sua equipe a se concentrarem e otimizarem o trabalho em questões que exigem sua atenção, enquanto o Amazon Q trabalha em uma solução para problemas que você não tem recursos para resolver imediatamente.

dica

O Amazon Q tem melhor desempenho em questões e problemas simples. Para ter melhores resultados, use uma linguagem simples para explicar claramente o que você quer que seja feito.

Quando você atribui um problema ao Amazon Q, o CodeCatalyst marca o problema como bloqueado até que você confirme como deseja que o Amazon Q trabalhe no problema. Isso exige que você responda a três perguntas antes de continuar:

  • Se você deseja confirmar cada etapa necessária ou se deseja prosseguir sem feedback. Se você optar por confirmar cada etapa, poderá responder ao Amazon Q com comentários sobre a abordagem criada para poder iterar a abordagem, se necessário. O Amazon Q também pode revisar os comentários que os usuários deixam sobre qualquer solicitação pull criada se você escolher essa opção. Se você optar por não confirmar cada etapa, o Amazon Q poderá concluir o trabalho mais rapidamente, mas não analisará nenhum comentário fornecido sobre o problema ou em qualquer solicitação pull criada.

  • Se você deseja permitir que ele atualize os arquivos do fluxo de trabalho como parte do trabalho. Seu projeto pode ter fluxos de trabalho configurados para iniciar execuções em eventos de solicitação pull. Nesse caso, qualquer solicitação pull criada pela Amazon Q que inclua a criação ou atualização do YAML do fluxo de trabalho pode iniciar uma execução desses fluxos de trabalho incluídos na solicitação pull. Como prática recomendada, não permita que o Amazon Q trabalhe em arquivos de fluxo de trabalho, a menos que tenha certeza de que não há fluxos de trabalho em seu projeto que executem automaticamente esses fluxos de trabalho antes de você revisar e aprovar a solicitação pull criada por ele.

  • Se você quer permitir que ele sugira a criação de tarefas para dividir o trabalho no problema em incrementos menores que podem ser atribuídos individualmente aos usuários, incluindo o próprio Amazon Q. Permitir que o Amazon Q sugira e crie tarefas pode ajudar a acelerar o desenvolvimento de problemas complexos, permitindo que várias pessoas trabalhem em partes distintas do problema. Também pode ajudar a reduzir a complexidade de entender todo o trabalho, pois o trabalho necessário para concluir cada tarefa é, de preferência, mais simples do que o problema ao qual ele pertence.

  • Em qual repositório de origem você deseja que ele trabalhe. Mesmo que seu projeto tenha vários repositórios de origem, o Amazon Q só pode trabalhar com código em um repositório de origem. Não há suporte a repositórios vinculados.

Depois de fazer e confirmar suas escolhas, o Amazon Q moverá o problema para o estado Em andamento enquanto tenta determinar qual é a solicitação com base no título e na descrição do problema, bem como no código no repositório especificado. Ele criará um comentário fixo onde fornecerá atualizações sobre o status do trabalho. Depois de analisar os dados, a Amazon Q formulará uma possível abordagem para uma solução. O Amazon Q registra as ações atualizando o comentário fixo e comentando sobre o progresso no problema em todas as etapas. Ao contrário dos comentários fixos e das respostas, ele não mantém um registro estritamente cronológico do trabalho. Em vez disso, ele coloca as informações mais relevantes sobre o trabalho no nível superior do comentário fixo. Ele tentará criar código com base na abordagem e na análise do código que já está no repositório. Se gerar uma solução em potencial, ele criará uma ramificação e enviará o código para essa ramificação. Em seguida, ele cria uma solicitação pull que mesclará essa ramificação com a ramificação padrão. Quando o Amazon Q conclui o trabalho, ele move o problema para Em análise para que você e sua equipe saibam que há um código pronto para avaliação.

nota

Esse recurso está disponível somente por meio de Problemas na região Oeste dos EUA (Oregon). Ele não estará disponível se você tiver configurado o projeto para usar o Jira com a extensão Software Jira. Além disso, se você personalizou o layout do quadro, o problema pode não mudar de estado. Para ter melhores resultados, use esse recurso somente com projetos que tenham um layout de quadro padrão.

Esse recurso não funciona com submódulos do Git. Ele não pode fazer alterações em nenhum submódulo do Git incluído no repositório.

Depois de atribuir um problema ao Amazon Q, você não pode alterar o título ou a descrição do problema nem atribuí-lo a outra pessoa. Se você cancelar a atribuição do problema ao Amazon Q, ele concluirá a etapa atual e, depois, deixará de funcionar. Ele não pode retomar o trabalho nem ser reatribuído ao problema depois do cancelamento da atribuição.

Um problema pode ser movido automaticamente para a coluna Em análise se atribuído ao Amazon Q, se um usuário optar por permitir que ele crie tarefas. No entanto, o problema em Em análise ainda pode ter tarefas que estão em um estado diferente, como no estado Em andamento.

Nesta parte do tutorial, você criará três problemas com base em possíveis recursos do código incluído em projetos criados com o esquema de aplicação web moderna de três níveis: um para adicionar ou criar uma criatura mysfit, um para adicionar um recurso de classificação e um para atualizar um fluxo de trabalho para incluir uma ramificação chamada test.

nota

Se você estiver trabalhando em um projeto com código diferente, crie problemas com títulos e descrições relacionados a essa base de código.

Como criar um problema e gerar uma solução para você avaliar

  1. No painel de navegação, selecione Problemas e verifique se você está na visualização Quadro.

  2. Selecione Criar problema.

  3. Dê ao problema um título que explique o que você quer fazer em linguagem simples. Por exemplo, para esse problema, insira o título Create another mysfit named Quokkapus. Em Descrição, forneça os seguintes detalhes:

    Expand the table of mysfits to 13, and give the new mysfit the following characteristics:

Name: Quokkapus

Species: Quokka-Octopus hybrid

Good/Evil: Good

Lawful/Chaotic: Chaotic

Age: 216

Description: Australia is full of amazing marsupials, but there's nothing there quite like the Quokkapus. 
She's always got a friendly smile on her face, especially when she's using her eight limbs to wrap you up 
in a great big hug. She exists on a diet of code bugs and caffeine. If you've got some gnarly code that needsa
assistance, adopt Quokkapus and put her to work - she'll love it! Just make sure you leave enough room for 
her to grow, and keep that coffee coming.

  4. (Opcional) Anexe uma imagem para usar como miniatura e foto do perfil do mysfit ao problema. Se você fizer isso, atualize a descrição para incluir detalhes sobre quais imagens deseja usar e por quê. Por exemplo, você pode adicionar o seguinte à descrição: “O mysfit requer que arquivos de imagem sejam implantados no site. Adicione as imagens anexadas a este problema ao repositório de origem como parte do trabalho e implante as imagens no site.”

    nota

    As imagens anexadas podem ou não ser implantadas no site durante as interações neste tutorial. Você mesmo pode adicionar as imagens ao site e, depois, deixar comentários para que o Amazon Q atualize o código para apontar para as imagens que você deseja usar depois de criar uma solicitação pull.

    Analise a descrição e verifique se ela contém todos os detalhes que possam ser necessários antes de prosseguir para a próxima etapa.

  5. Em Destinatários, selecione Atribuir ao Amazon Q.

  6. Em Repositório de origem, escolha o nome do repositório que contém o código do projeto.

  7. Deslize o seletor Exigir que o Amazon Q pare após cada etapa e aguarde a revisão do trabalho até o estado ativo, se necessário.

    nota

    Escolher a opção de interromper o Amazon Q após cada etapa permite que você comente sobre o problema ou sobre qualquer tarefa criada para ter a opção de fazer com que o Amazon Q mude de abordagem até três vezes com base em seus comentários. Se você escolher a opção de não deixar o Amazon Q parar após cada etapa para poder revisar o trabalho, o trabalho poderá prosseguir mais rapidamente porque o Amazon Q não está esperando seus comentários, mas você não poderá influenciar a direção que o Amazon Q tomará ao deixar comentários. O Amazon Q também não responderá aos comentários deixados em uma solicitação pull se você escolher essa opção.

  8. Deixe o seletor Permitir que o Amazon Q modifique arquivos de fluxo de trabalho no estado inativo.

  9. Deslize o seletor Permitir que o Amazon Q sugira a criação de tarefas para o estado ativo.

  10. Selecione Criar problema. A visualização muda para o quadro Problemas.

  11. Selecione Criar problema para criar outro problema, desta vez com o título Change the get_all_mysfits() API to return mysfits sorted by the Age attribute. Atribua esse problema ao Amazon Q e crie o problema.

  12. Selecione Criar problema para criar outro problema, desta vez com o título Update the OnPullRequest workflow to include a branch named test in its triggers. Se desejar, vincule ao fluxo de trabalho na descrição. Atribua esse problema ao Amazon Q, mas desta vez garanta que o seletor Permitir que o Amazon Q modifique arquivos de fluxo de trabalho esteja configurado para o estado ativo. Crie o problema para retornar ao quadro Problemas.

    dica

    Você pode procurar arquivos, incluindo arquivos de fluxo de trabalho, inserindo o símbolo de arroba (@) e o nome do arquivo.

Depois de criar e atribuir os problemas, eles passarão para o estado Em andamento. O Amazon Q adicionará comentários de acompanhamento do progresso no problema em um comentário fixo. Se for possível definir uma abordagem para uma solução, ele atualizará a descrição do problema com uma seção Contexto que contém a análise da base de código e uma seção Abordagem que detalha a abordagem proposta para criar uma solução. Se o Amazon Q conseguir encontrar uma solução para o problema descrito, ele criará uma ramificação e alterações de código nessa ramificação que implementarão a solução proposta. Se o código proposto contiver semelhanças com o código-fonte aberto que o Amazon Q conhece, ele fornecerá um arquivo que inclui links para esse código para que você possa analisá-lo. Quando o código estiver pronto, ele criará uma solicitação pull para que você possa revisar as alterações de código sugeridas, adicionará um link para essa solicitação pull para o problema e moverá o problema para Em revisão.

Importante

Você sempre deve revisar todas as alterações de código em uma solicitação pull antes de mesclá-la. A mesclagem de alterações de código feitas pelo Amazon Q, como qualquer outra alteração de código, pode afetar negativamente a base de código e o código de infraestrutura se o código mesclado não for revisado adequadamente e contiver erros ao mesclar.

Para analisar um problema e uma solicitação pull vinculada que contém alterações feitas pelo Amazon Q

  1. Em Problemas, escolha um problema atribuído ao Amazon Q que esteja no estado Em andamento. Analise os comentários para monitorar o progresso do Amazon Q. Se estiver presente, analise o contexto e aborde os registros na descrição do problema. Se você optar por permitir que o Amazon Q sugira tarefas, revise todas as tarefas propostas e tome as medidas necessárias. Por exemplo, se o Amazon Q sugeriu tarefas e você gostaria de alterar a ordem ou atribuir tarefas a usuários específicos, escolha Alterar, adicionar ou reordenar tarefas e realize as atualizações necessárias. Quando terminar de visualizar o problema, escolha X para fechar o painel do problema.

    dica

    Para ver o progresso das tarefas, escolha a tarefa na lista de tarefas no problema. As tarefas não aparecem como itens separados no quadro e só podem ser acessadas por meio de um problema. Se uma tarefa for atribuída ao Amazon Q, você deverá abri-la para aprovar qualquer ação que ela queira realizar. Você também deve abrir uma tarefa para ver todas as solicitações pull vinculadas, pois elas não aparecerão como links no problema, somente na tarefa. Para retornar a um problema a partir de uma tarefa, escolha o link para o problema.

  2. Agora escolha um problema atribuído ao Amazon Q que esteja no estado Em análise. Analise o contexto e aborde os registros na descrição do problema. Analise os comentários para entender as ações realizadas. Analise todas as tarefas criadas para trabalhar relacionadas a esse problema, incluindo o progresso, quaisquer ações que você talvez precise realizar e quaisquer comentários. Em Solicitações pull, escolha o link para a solicitação pull ao lado do rótulo Abrir para revisar o código.

    dica

    As solicitações pull geradas para tarefas só aparecem como solicitações pull vinculadas na visualização da tarefa. Elas não aparecem como solicitações pull vinculadas para o problema.

  3. Na solicitação pull, revise as alterações no código. Para ter mais informações, consulte Revisão de uma solicitação pull. Deixe comentários sobre a solicitação pull se quiser que o Amazon Q altere qualquer código sugerido. Seja específico ao deixar comentários no Amazon Q para ter melhores resultados.

    Por exemplo, ao revisar a solicitação pull criada para Create another mysfit named Quokkapus, você pode perceber que há um erro de digitação na descrição. Você pode deixar um comentário para o Amazon Q dizendo “Altere a descrição para corrigir o erro de digitação “needsa” adicionando um espaço entre “needs” e “a”.” Como alternativa, você pode deixar um comentário pedindo ao Amazon Q que atualize a descrição e forneça toda a descrição revisada para que ela seja incorporada.

    Se você fez upload de imagens do novo mysfit para o site, pode deixar um comentário para o Amazon Q atualizar o mysfit com ponteiros para a imagem e miniatura para usar no novo mysfit.

    nota

    O Amazon Q não responderá a comentários individuais. O Amazon Q só incorporará o feedback deixado nos comentários em solicitações pull se você escolher a opção padrão de parar após cada etapa de aprovação ao criar o problema.

  4. (Opcional) Depois que você e outros usuários do projeto deixarem todos os comentários desejados sobre as alterações no código, selecione Criar revisão para que o Amazon Q crie uma revisão da solicitação pull que incorpore as alterações solicitadas nos comentários. O progresso da criação da revisão será relatado pelo Amazon Q em Visão geral, não em Alterações. Atualize seu navegador para ver as atualizações mais recentes do Amazon Q sobre a criação da revisão.

    nota

    Somente o usuário que criou o problema pode criar uma revisão da solicitação pull. Você só pode solicitar uma revisão de uma solicitação pull. Verifique se você resolveu todos os problemas com os comentários e se está satisfeito com o conteúdo dos comentários antes de escolher Criar revisão.

  5. Um fluxo de trabalho é executado para cada solicitação pull neste projeto de exemplo. Veja um fluxo de trabalho executado com sucesso antes de mesclar a solicitação pull. Você também pode optar por criar fluxos de trabalho e ambientes adicionais para testar o código antes de mesclá-lo. Para ter mais informações, consulte Conceitos básicos de fluxos de trabalho.

  6. Quando estiver satisfeito com a revisão mais recente da solicitação pull, selecione Mesclar.

Criar um problema e ter tarefas recomendadas pelo Amazon Q para ele

Às vezes, um problema pode conter quantidades de trabalho complexas ou demoradas. O CodeCatalyst inclui a integração com o agente do Amazon Q Developer para desenvolvimento de software. Você pode pedir ao Amazon Q que analise um problema com base no título e na descrição e recomende uma divisão lógica do trabalho em tarefas separadas. Ele tentará criar uma lista de tarefas recomendadas que podem revisar, modificar e escolher se deseja criar. Isso pode ajudar você e sua equipe a atribuir partes individuais do trabalho aos usuários de maneiras mais gerenciáveis que podem ser realizadas mais rapidamente.

Para criar e revisar uma lista de tarefas recomendadas para um problema

  1. No painel de navegação, selecione Problemas e verifique se você está na visualização Quadro.

  2. Selecione Criar problema.

  3. Dê ao problema um título que explique o que você quer fazer em linguagem simples. Por exemplo, para esse problema, insira o título Change the get_all_mysfits() API to return mysfits sorted by the Good/Evil attribute. Em Descrição, forneça os seguintes detalhes:

    Update the API to allow sorting of mysfits by whether they are Good, Neutral, or Evil. Add a button on the website that allows users to quickly choose this sort and to exclude alignments that they don't want to see.

  4. Analise a descrição e verifique se ela contém todos os detalhes que possam ser necessários antes de prosseguir para a próxima etapa.

  5. Em Responsáveis, atribua o problema a você mesmo.

  6. Selecione Criar problema. A visualização muda para o quadro Problemas.

  7. Escolha o problema que você acabou de criar para abri-lo. Selecione Recomendar tarefas.

  8. Escolha o repositório de origem que contém o código do problema. Selecione Começar a recomendar tarefas.

A caixa de diálogo será fechada e o Amazon Q começará a analisar a complexidade do problema. Se o problema for complexo, ele sugerirá uma divisão do trabalho em tarefas sequenciais separadas. Quando a lista estiver pronta, selecione Exibir tarefas recomendadas. Você pode adicionar outras tarefas, modificar as tarefas recomendadas e reordenar as tarefas. Se você concordar com as recomendações, selecionar a opção Criar tarefas criará as tarefas. Você pode atribuir essas tarefas aos usuários para que trabalhem nelas, ou até mesmo ao próprio Amazon Q.

Limpar os recursos

Depois de concluir este tutorial, considere realizar as ações a seguir para limpar todos os recursos que você criou durante este tutorial e que não sejam mais necessários.

  • Cancele a atribuição do Amazon Q a qualquer problema que não esteja mais sendo resolvido. Se o Amazon Q tiver concluído o trabalho em um problema ou não conseguir encontrar uma solução, cancele a atribuição do Amazon Q para evitar atingir a cota máxima de recursos de IA generativa. Para ter mais informações, consulte Gerenciamento de recursos de IA generativa e Preços.

  • Mova qualquer problema em que o trabalho esteja concluído para Concluído.

  • Se o projeto não for mais necessário, exclua-o.