Tutorial: Usando recursos CodeCatalyst generativos de IA para acelerar seu trabalho de desenvolvimento - Amazon CodeCatalyst
Pré-requisitosUsando o Amazon Q para escolher um modelo ao criar um projeto ou adicionar funcionalidadeAdicione um resumo gerado automaticamente ao criar uma pull requestCrie um resumo dos comentários deixados sobre alterações de código em uma pull requestCrie um problema e atribua-o ao Amazon QCrie um problema e tenha tarefas recomendadas para ele pela Amazon QLimpar os recursos

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Tutorial: Usando recursos CodeCatalyst generativos de IA para acelerar seu trabalho de desenvolvimento

Se você tem um projeto e um repositório de origem na Amazon CodeCatalyst em um espaço onde os recursos generativos de IA 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 suas alterações de código aos colegas de equipe ao criar pull requests para análise dessas alterações, esperando que outros usuários achem as alterações autoexplicativas. Os criadores e revisores do pull request também não têm tempo para encontrar e ler todos os comentários em um pull request minuciosamente, especialmente se o pull request tiver várias revisões. CodeCatalyst se integra ao Amazon Q Developer Agent para desenvolvimento de software para fornecer recursos generativos de IA que podem ajudar os membros da equipe a realizar suas 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 generativo baseado em IA que pode ajudar você a entender, criar, estender e operar aplicativos. AWS Para acelerar sua construção AWS, o modelo que impulsiona o Amazon Q é aprimorado com AWS conteúdo de alta qualidade para produzir respostas mais completas, acionáveis e referenciadas. Para obter mais informações, consulte O que é o Amazon Q Developer? no Amazon Q Developer User Guide.

nota

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

Neste tutorial, você aprenderá a usar os recursos generativos de IA CodeCatalyst para ajudá-lo a criar projetos com blueprints, bem como adicionar blueprints a projetos existentes. Além disso, você aprenderá a resumir as alterações entre as ramificações ao criar pull requests e a resumir os comentários deixados em uma pull request. 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 CodeCatalyst recursos deste tutorial, você deve primeiro ter concluído e ter acesso aos seguintes recursos:

  • Você tem um AWS Builder ID ou uma identidade de login único (SSO) para fazer login. CodeCatalyst

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

  • Você tem a função 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 para ele. Não há suporte para repositórios vinculados.

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

Para obter mais informações, consulte Criando um espaço, Acompanhe e organize o trabalho com problemas no CodeCatalyst, Adicione funcionalidade a projetos com extensões no CodeCatalyst e Concedendo acesso com funções de usuário.

Este tutorial é baseado em um projeto criado usando o modelo de aplicativo web moderno de três camadas com Python. Se você usar um projeto criado com um blueprint diferente, ainda poderá seguir as etapas, mas algumas especificidades podem variar, como código e linguagem de exemplo.

Usando o Amazon Q para escolher um modelo ao criar um projeto ou adicionar funcionalidade

Como desenvolvedor de projetos, você pode colaborar com o Amazon Q, um assistente generativo de IA, ao criar novos projetos ou adicionar componentes a projetos existentes. Você pode fornecer ao Amazon Q os requisitos para seu projeto interagindo com ele em uma interface semelhante a um bate-papo. Com base em seus requisitos, o Amazon Q sugere um plano e também descreve os requisitos que não podem ser atendidos. Se o seu espaço tiver plantas personalizadas, o Amazon Q aprende e também inclui essas plantas nas recomendações. Você pode então continuar com a sugestão da Amazon Q se estiver satisfeito, e ela criará os recursos necessários, como um repositório de origem com código para sua necessidade. O Amazon Q também cria problemas para requisitos que não podem ser satisfeitos com um plano. Para saber mais sobre os CodeCatalyst esquemas disponíveis, consulteCriando um projeto abrangente com CodeCatalyst plantas. Para saber mais sobre como usar o Amazon Q com plantas, consulteMelhores práticas ao usar o Amazon Q para criar projetos ou adicionar funcionalidades com blueprints.

Para criar um projeto com o Amazon Q

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

  2. No CodeCatalyst console, navegue até o espaço em que você deseja criar um blueprint.

  3. No painel do espaço, escolha Create with 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 Experimente exemplos, você pode usar um prompt pré-escrito escolhendo um blueprint. Por exemplo, se você escolher o aplicativo 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. Escolha Enviar para enviar suas instruções para a Amazon Q. O assistente generativo de IA fornece uma sugestão e descreve os requisitos que não podem ser atendidos pelo plano. 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 detalhados do blueprint sugerido, escolha Exibir detalhes.

  7. Execute um destes procedimentos:

    1. Escolha Sim, use esse esquema se estiver satisfeito com a sugestão.

    2. Escolha Editar solicitação se quiser modificar a solicitação.

    3. Escolha Recomeçar se quiser limpar completamente a solicitação.

  8. Execute um destes procedimentos:

    1. Escolha Configurar se quiser configurar o blueprint sugerido. Você também pode configurar o blueprint posteriormente.

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

  9. Se você optar por configurar o blueprint, escolha Continuar após 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. Escolha Criar projeto para criar um projeto com o blueprint. O Amazon Q cria recursos usando o modelo. Por exemplo, se você criar um projeto com o blueprint de aplicativo 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 plano. Você pode escolher para quais itens você não quer 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, fornecendo um resumo dos arquivos e códigos de origem relevantes. Para mais informações, consulte Encontrando e visualizando problemas, Crie um problema e atribua-o ao Amazon Q e Melhores práticas 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 CodeCatalyst esquemas com base em seus requisitos.

Para adicionar um blueprint com o Amazon Q

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

  2. No CodeCatalyst console, navegue até o projeto em que você deseja adicionar um blueprint.

  3. Escolha 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 Experimente exemplos, você pode usar um prompt pré-escrito escolhendo um blueprint. Por exemplo, se você escolher o aplicativo 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. Escolha Enviar para enviar suas instruções para a Amazon Q. O assistente generativo de IA fornece uma sugestão e descreve os requisitos que não podem ser atendidos pelo plano. 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 detalhados do blueprint sugerido, escolha Exibir detalhes.

  7. Execute um destes procedimentos:

    1. Escolha Sim, use esse esquema se estiver satisfeito com a sugestão.

    2. Escolha Editar solicitação se quiser modificar a solicitação.

    3. Escolha Recomeçar se quiser limpar completamente a solicitação.

  8. Execute um destes procedimentos:

    1. Escolha Configurar se quiser configurar o blueprint sugerido. Você também pode configurar o blueprint posteriormente.

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

  9. Se você optar por configurar o blueprint, escolha Continuar após modificar os recursos do projeto.

  10. Escolha Adicionar ao projeto para adicionar recursos a um projeto com o blueprint. O Amazon Q cria recursos usando o modelo. Por exemplo, se você adicionar a um projeto o blueprint de aplicativo 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 plano. Você pode escolher para quais itens você não quer 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, fornecendo um resumo dos arquivos e códigos de origem relevantes. Para obter mais informações, consulte Crie um problema e atribua-o ao Amazon Q e Melhores práticas ao criar e trabalhar com problemas atribuídos ao Amazon Q.

Crie um resumo das alterações de código entre as ramificações ao criar uma pull request

Uma pull request é a principal forma pela qual você e outros membros do projeto podem revisar, comentar e mesclar alterações de código de uma ramificação para outra. Você pode usar pull requests para revisar as alterações no código de forma colaborativa em busca de pequenas alterações ou correções, adições de recursos importantes 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 pull request é ú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 suas 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 mudanças no código.

Você pode usar o recurso Write description for me ao criar pull requests para que o Amazon Q crie uma descrição das alterações contidas em um pull request. 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 filial de destino na qual você deseja mesclar essas alterações. Em seguida, ele cria um resumo do que são essas mudanças, bem como sua melhor interpretação da intenção e do efeito dessas mudanças.

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 pull request.

Esse recurso não está disponível para pull requests em repositórios vinculados.

Você pode testar esse recurso com qualquer pull request que você criar, mas neste tutorial, vamos testá-lo fazendo algumas alterações simples no código contido em um projeto criado em um blueprint de aplicativo web moderno de três camadas baseado em Python.

dica

Se você estiver usando um projeto criado com um blueprint diferente ou 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 seu projeto em uma ramificação e, em seguida, crie uma pull request 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. Em seguida, você criará uma pull request e usará o recurso Escrever descrição para mim para resumir as alterações feitas.

Para criar uma ramificação (console)

  1. No CodeCatalyst console, navegue até o projeto em que seu repositório de origem reside.

  2. Escolha o nome do repositório na lista de repositórios de origem do projeto. Como alternativa, no painel de navegação, escolha Código e, em seguida, escolha Repositórios de origem.

  3. Escolha o repositório em que você deseja criar uma ramificação.

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

  5. Insira um nome para a filial.

  6. Escolha uma ramificação a partir da qual criar a ramificação e, em seguida, escolha Criar.

Depois de ter uma ramificação, edite um arquivo nessa ramificação com uma simples alteração. Neste exemplo, você editará o test_endpoint.py arquivo para alterar o número de novas tentativas de testes de 1 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 test_endpoint.py arquivo no console

  1. Na página de visão geral do repositório de mysfits origem, escolha a ramificação suspensa 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 test_endpoint.py arquivo, expanda testes, expanda integ e escolhatest_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 a partir de:

    def test_list_all(retry=3):

    para:

    def test_list_all(retry=5):

  5. Escolha Confirmar e confirme suas alterações em sua filial.

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

Crie uma pull request com um resumo das alterações

  1. Na página de visão geral do repositório, escolha Mais e, em seguida, escolha Criar pull request.

  2. Em Agência de destino, escolha a ramificação na qual mesclar o código depois que ele for revisado.

    dica

    Escolha a ramificação a partir da qual você criou sua ramificação no procedimento anterior para obter 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 para sua pull request.

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

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

  5. Em Descrição do pull request, escolha Write description for me para que o Amazon Q crie uma descrição das alterações contidas no pull request.

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

  7. Opcionalmente, 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 pull request. Quando terminar de fazer as alterações adicionais desejadas, escolha Criar.

Crie um resumo dos comentários deixados sobre alterações de código em uma pull request

Quando os usuários revisam uma pull request, eles geralmente deixam vários comentários sobre as alterações nessa pull request. Se houver muitos comentários de muitos revisores, pode ser difícil escolher temas comuns no feedback 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 pull request e crie um resumo desses comentários.

nota

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

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 pull requests em repositórios vinculados.

Para criar um resumo dos comentários em uma pull request

  1. Navegue até a pull request que você criou no procedimento anterior.

    dica

    Se preferir, você pode usar qualquer pull request aberta em seu projeto. Na barra de navegação, escolha Código, escolha Pull requests e escolha qualquer pull request aberta.

  2. Adicione alguns comentários à pull request em Changes se a pull request ainda não tiver comentários.

  3. Em Visão geral, escolha 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 pull request e compare-o com os comentários na pull request.

Crie um problema e atribua-o ao Amazon Q

As equipes de desenvolvimento criam problemas para monitorar e gerenciar seu trabalho, mas às vezes um problema persiste porque não está claro quem deve trabalhar nele, ou o problema requer pesquisa em uma parte específica da base de código ou outro trabalho urgente deve ser realizado primeiro. CodeCatalyst inclui integração com o Amazon Q Developer Agent para desenvolvimento de software. Você pode atribuir problemas a um assistente generativo de IA chamado Amazon Q, que pode analisar um problema com base no título e na descrição. Se você atribuir o problema à Amazon Q, ela tentará criar uma solução preliminar para você avaliar. Isso pode ajudar você e sua equipe a se concentrarem e otimizarem seu trabalho em questões que exigem sua atenção, enquanto a 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 simples e problemas simples. Para obter melhores resultados, use uma linguagem simples para explicar claramente o que você quer que seja feito.

Quando você atribui um problema ao Amazon Q, CodeCatalyst marcará o problema como bloqueado até que você confirme como deseja que o Amazon Q resolva o 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 à Amazon Q com feedback sobre a abordagem que ela cria para que ela possa iterar sua abordagem, se necessário. O Amazon Q também pode revisar o feedback que os usuários deixam sobre qualquer pull request criado se você escolher essa opção. Se você optar por não confirmar cada etapa, o Amazon Q poderá concluir seu trabalho mais rapidamente, mas não analisará nenhum feedback que você fornecer sobre o problema ou em qualquer pull request criado.

  • Se você deseja permitir que ele atualize os arquivos do fluxo de trabalho como parte de seu trabalho. Seu projeto pode ter fluxos de trabalho configurados para iniciar execuções em eventos de pull request. Nesse caso, qualquer pull request criada pela Amazon Q que inclua a criação ou atualização do fluxo de trabalho YAML pode iniciar uma execução desses fluxos de trabalho incluídos na pull request. Como prática recomendada, não escolha permitir 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 pull request criada por ele.

  • Se você quiser permitir que ele sugira a criação de tarefas para dividir o trabalho na edição em incrementos menores que podem ser atribuídos individualmente aos usuários, incluindo o próprio Amazon Q. Permitir que a 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 a totalidade do trabalho, pois o trabalho necessário para concluir cada tarefa é idealmente mais simples do que o problema ao qual pertence.

  • Em qual repositório de origem você deseja que ele funcione. 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 para 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 de seu trabalho. Depois de analisar os dados, a Amazon Q formulará uma possível abordagem para uma solução. O Amazon Q registra suas ações atualizando seu comentário fixo e comentando sobre seu progresso na questão em todas as etapas. Ao contrário dos comentários e respostas fixos, ele não mantém um registro estritamente cronológico de seu trabalho. Em vez disso, ele coloca as informações mais relevantes sobre seu trabalho no nível superior do comentário fixado. Ele tentará criar código com base em sua abordagem e análise do código que já está no repositório. Se gerar com sucesso uma solução potencial, ele criará uma ramificação e enviará o código para essa ramificação. Em seguida, ele cria uma pull request que mesclará essa ramificação com a ramificação padrão. Quando o Amazon Q conclui seu trabalho, ele move o problema para Em análise para que você e sua equipe saibam que há um código pronto para serem avaliados.

nota

Esse recurso só está disponível por meio de edições na região Oeste dos EUA (Oregon). Ela não estará disponível se você tiver configurado seu projeto para usar o Jira com a extensão Jira Software. Além disso, se você personalizou o layout do seu quadro, o problema pode não mudar de estado. Para obter 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 uma edição à Amazon Q, você não pode alterar o título ou a descrição da edição nem atribuí-la a outra pessoa. Se você cancelar a atribuição do Amazon Q ao problema, ele concluirá a etapa atual e, em seguida, deixará de funcionar. Ele não pode retomar o trabalho ou ser reatribuído ao problema depois de não ter sido atribuído.

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 em um estado diferente, como no estado Em andamento.

Nesta parte do tutorial, você criará três problemas com base em recursos potenciais para o código incluído em projetos criados com o modelo moderno de aplicativo web de três camadas: um para adicionar um para criar uma nova 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.

Para criar um problema e ter uma solução gerada para você avaliar

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

  2. Escolha Criar problema.

  3. Dê à edição um título que explique o que você quer fazer em linguagem simples. Por exemplo, para esse problema, insira um título deCreate 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 à edição. Se você fizer isso, atualize a descrição para incluir detalhes sobre quais imagens você 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 essas imagens anexadas a esta edição 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, em seguida, deixar comentários para que o Amazon Q atualize seu código para apontar para as imagens que você deseja usar depois de criar uma pull request.

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

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

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

  7. Deslize o botão Exigir que o Amazon Q pare após cada etapa e aguarde a revisão de seu seletor de 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 altere sua abordagem em 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 seu trabalho, o trabalho poderá prosseguir mais rapidamente porque o Amazon Q não está esperando por seu feedback, mas você não poderá influenciar a direção que o Amazon Q tomará deixando comentários. O Amazon Q também não responderá aos comentários deixados em uma pull request 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 botão Permitir que o Amazon Q sugira a criação do seletor de tarefas para o estado ativo.

  10. Escolha Criar problema. Sua visão muda para o quadro de problemas.

  11. Escolha Criar edição para criar outra edição, desta vez com o títuloChange the get_all_mysfits() API to return mysfits sorted by the Age attribute. Atribua esse problema ao Amazon Q e crie o problema.

  12. Escolha Criar edição para criar outra edição, desta vez com o títuloUpdate the OnPullRequest workflow to include a branch named test in its triggers. Opcionalmente, vincule ao fluxo de trabalho na descrição. Atribua esse problema ao Amazon Q, mas desta vez certifique-se de 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 de problemas.

    dica

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

Depois de criar e atribuir os problemas, eles passarão para Em andamento. O Amazon Q adicionará comentários acompanhando seu progresso no problema em um comentário fixo. Se for capaz de definir uma abordagem para uma solução, atualizará a descrição do problema com uma seção de plano de fundo que contém a análise da base de código e uma seção de abordagem que detalha a abordagem proposta para criar uma solução. Se a Amazon Q conseguir encontrar uma solução para o problema descrito na questão, ela 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 a 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 cria uma pull request para que você possa revisar as alterações de código sugeridas, adiciona um link para essa pull request para o problema e move o problema para Em revisão.

Importante

Você deve sempre revisar todas as alterações de código em uma pull request 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 sua base de código e código de infraestrutura se o código mesclado não for revisado adequadamente e contiver erros ao mesclar.

Para analisar um problema e um pull request vinculado que contém alterações feitas pela Amazon Q

  1. Em Problemas, escolha um problema atribuído ao Amazon Q que esteja em andamento. Analise os comentários para monitorar o progresso do Amazon Q. Se estiver presente, analise o histórico 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 realizar 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 na edição. 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 pull requests 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 em análise. Analise o histórico e aborde os registros na descrição do problema. Analise os comentários para entender as ações que ele executou. Analise todas as tarefas criadas para trabalhar relacionadas a esse problema, incluindo seu progresso, quaisquer ações que você possa precisar realizar e quaisquer comentários. Em Pull requests, escolha o link para o pull request ao lado do rótulo Abrir para revisar o código.

    dica

    As pull requests geradas para tarefas só aparecem como pull requests vinculadas na visualização da tarefa. Eles não aparecem como pull requests vinculados para o problema.

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

    Por exemplo, ao revisar a pull request criada paraCreate 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 à 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 a Amazon Q atualizar o mysfit com ponteiros para a imagem e miniatura para usar no novo mysfit.

    nota

    A Amazon Q não responderá a comentários individuais. O Amazon Q só incorporará o feedback deixado nos comentários em pull requests 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, escolha Criar revisão para que o Amazon Q crie uma revisão da pull request que incorpore as alterações solicitadas nos comentários. O progresso no progresso da criação da revisão será relatado pela Amazon Q em Visão geral, não em Alterações. Certifique-se de atualizar seu navegador para ver as atualizações mais recentes da Amazon Q sobre a criação da revisão.

    nota

    Somente o usuário que criou o problema pode criar uma revisão da pull request. Você só pode solicitar uma revisão de um pull request. 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 pull request neste projeto de exemplo. Certifique-se de ver um fluxo de trabalho executado com sucesso antes de mesclar a pull request. 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 Introdução aos fluxos de trabalho.

  6. Quando estiver satisfeito com a revisão mais recente da pull request, escolha Mesclar.

Crie um problema e tenha tarefas recomendadas para ele pela Amazon Q

Às vezes, um problema pode conter quantidades de trabalho complexas ou demoradas. CodeCatalyst inclui integração com o Amazon Q Developer Agent para desenvolvimento de software. Você pode pedir à 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 então 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, escolha Problemas e verifique se você está na visualização do quadro.

  2. Escolha Criar problema.

  3. Dê à edição um título que explique o que você quer fazer em linguagem simples. Por exemplo, para esse problema, insira um título deChange 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. Revise a descrição e verifique se ela contém todos os detalhes que podem ser necessários antes de prosseguir para a próxima etapa.

  5. Em Responsáveis, escolha atribuir a ocorrência a você mesmo.

  6. Escolha Criar problema. Sua visão muda para o quadro de problemas.

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

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

A caixa de diálogo será fechada e a 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, escolha Exibir tarefas recomendadas. Você pode adicionar tarefas adicionais, modificar as tarefas recomendadas e reordenar as tarefas. Se você concordar com as recomendações, escolher Criar tarefas criará as tarefas. Você pode então 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 quaisquer problemas que não estejam mais sendo resolvidos. Se o Amazon Q tiver concluído seu trabalho em um problema ou não conseguir encontrar uma solução, certifique-se de cancelar a atribuição do Amazon Q para evitar atingir a cota máxima de recursos generativos de IA. Para obter mais informações, consulte Gerenciamento de recursos e preços generativos de IA.

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

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