Usando o agente de nuvem do GitHub Copilot para melhorar um projeto

Introdução

O desenvolvimento moderno geralmente começa com boas intenções: um script rápido, um protótipo, talvez uma ação para automatizar uma pequena coisa. Mas à medida que os projetos evoluem, esses primeiros esforços podem se tornar frágeis.

Este tutorial mostra como você pode usar Agente de nuvem Copilot para melhorar um projeto maduro, sem diminuir o ritmo.

Nas seções a seguir, vamos:

• Verifique se o projeto contém instruções personalizadas que Copilot podem ser usadas para adaptar suas respostas ao seu projeto.
• Verifique se há um arquivo de configuração de ambiente para Agente de nuvem Copilot para que ele possa iniciar as tarefas mais rapidamente ao pré-instalar as dependências do projeto.
• Solicite que Copilot procure melhorias que possam ser feitas no código e crie tarefas para esse trabalho.
• Delegar o trabalho de codificação para Copilot ao atribuí-lo a uma tarefa.

1. Verifique se há instruções personalizadas

1. Vá para o repositório em GitHub.

2. Verifique se existe pelo menos um dos seguintes arquivos de instruções personalizadas:

   • .github/copilot-instructions.md
   • .github/instructions/**/*-instructions.md
   • AGENTS.md

3. Se houver algum desses arquivos, exiba o arquivo e verifique se as instruções são adequadas e atualizadas.

   Para obter mais informações, consulte a seção "Escrevendo instruções personalizadas efetivas" em Sobre a personalização das respostas do GitHub Copilot e a biblioteca de exemplos em Instruções personalizadas.

4. Se não houver arquivos de instruções personalizados no repositório, use Agente de nuvem Copilot para criar um .github/copilot-instructions.md arquivo seguindo as instruções em Adicionando instruções personalizadas do repositório para GitHub Copilot.

5. Examine a solicitação de pull que Agente de nuvem Copilot cria. Verifique se o .github/copilot-instructions.md arquivo fornece Copilot todas as informações que precisa saber para trabalhar neste projeto.

   O arquivo deve incluir:

   • Um resumo claro da base de código e o que o software faz.
   • Uma visão geral da estrutura do projeto.
   • Diretrizes de contribuição. Por exemplo, como criar, formatar, lintar e testar a base de código e os requisitos que devem ser atendidos antes que as solicitações de pull possam ser mescladas.
   • Principais princípios técnicos.

6. Edite o arquivo conforme necessário.

7. Clique em Pronto para revisão na parte inferior da guia "Conversa" da solicitação de pull e conclua seu processo habitual para mesclar uma solicitação de pull.

2. Verifique se há um arquivo de configuração de ambiente

Um copilot-setup-steps.ymlGitHub Actions arquivo de fluxo de trabalho pode ajudar Agente de nuvem Copilot a começar as tarefas mais rapidamente instalando previamente as dependências usadas pelo projeto.

Criar esse arquivo é opcional, mas é uma boa ideia se você usar Agente de nuvem Copilot regularmente no repositório.

1. Em seu repositório, GitHubverifique se o seguinte arquivo existe:

   Text

   .github/workflows/copilot-setup-steps.yml
   

   Dica

   Uma maneira rápida de fazer isso é copiar o caminho acima, ir para a página principal do seu repositório e colar o caminho no campo "Ir para o arquivo".

2. Se o arquivo existir, abra-o e verifique se as etapas do fluxo de trabalho instalam as dependências corretas para o projeto. Depois de verificar isso, você pode ignorar as etapas restantes nesta seção.

3. Se você ainda não tiver um arquivo copilot-setup-steps.yml, use as etapas a seguir para que Agente de nuvem Copilot o crie para você.

4. Na parte superior de qualquer página do repositório no site GitHub, clique .

5. Copie e cole o seguinte prompt na caixa de diálogo Agentes:

   Text

   Analyze this repository to understand the dependencies that need to be installed on the development environment to work on the code in this repository. Using this information, and the details about the `copilot-setup-steps.yml` file that are given in https://docs.github.com/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment, add a `.github/workflows/copilot-setup-steps.yml` to this repository. This Actions workflow file should install, in the development environment for Agente de nuvem Copilot, all of the dependencies necessary to work on the code in this repository. Make sure that the workflow job is named `copilot-setup-steps`.
   

6. Clique ou pressione Enter.

7. Na lista "Sessões de agente recentes", clique na nova sessão do agente iniciada.

   Isso exibe um log de atividades enquanto Copilot trabalha na tarefa. Quando Copilot terminar, ele gerará um resumo do que fez.

8. Leia o resumo e clique em Exibir solicitação de pull.

9. Opcionalmente, adicione Copilot como revisor. Para saber mais, confira Usando o GitHub Copilot para revisão de código. Aguarde para Copilot adicionar comentários de revisão e faça as alterações que você achar necessárias em resposta aos comentários.

10. Examine a solicitação de pull por conta própria, certificando-se de que as etapas de instalação no novo copilot-setup-steps.yml arquivo estejam corretas.

    O arquivo de fluxo de trabalho criado Copilot deve incluir um on: workflow_dispatch gatilho, para permitir que você execute o fluxo de trabalho manualmente e o trabalho deve ser nomeado copilot-setup-steps conforme mostrado neste extrato:

    on:
      workflow_dispatch:
      push:
        paths:
          - .github/workflows/copilot-setup-steps.yml
      pull_request:
        paths:
          - .github/workflows/copilot-setup-steps.yml
    
    jobs:
      copilot-setup-steps:
        runs-on: ubuntu-latest
    

11. Faça as alterações necessárias no copilot-setup-steps.yml arquivo na solicitação de pull.

    Você pode solicitar que Copilot faça alterações para você usando @copilot em um comentário de revisão. Por exemplo:

    @copilot - comment the file more thoroughly

12. Clique em Pronto para revisão na parte inferior da guia "Conversa" da solicitação de pull e conclua seu processo habitual para mesclar uma solicitação de pull.

13. Abra o arquivo recém-adicionado .github/workflows/copilot-setup-steps.yml em seu repositório no GitHub.

14. Clique em Exibir Execuções no canto superior direito da página.

15. Clique em Executar fluxo de trabalho e, em seguida, execute o fluxo de trabalho na caixa de diálogo para testar o novo fluxo de trabalho.

16. Verifique se o fluxo de trabalho é executado corretamente e instala as dependências. Corrija as falhas editando o arquivo .github/workflows/copilot-setup-steps.yml.

3. Vamos Copilot encontrar a dívida técnica

Agora que Copilot tem o contexto correto e (opcionalmente) um ambiente pronto para uso, você pode usá-lo para identificar e priorizar a dívida técnica no seu repositório.

1. Clique no botão na caixa de prompt a seguir para enviar esta mensagem para Chat Copilot no GitHub.com.

   Copilot prompt

   What technical debt exists in this project? Give me a prioritized list of up to 5 areas we need to focus on. For each, describe the problem and its consequences.
   

2. Verifique se o modo Perguntar está selecionado.

3. Use o menu suspenso Todos os repositórios para selecionar o seu repositório.

4. Clique ou pressione Enter.

5. Revise os detalhes na resposta de Copilot.

6. Supondo que Copilot tenha identificado pelo menos uma área para melhoria, copie o seguinte prompt para a mesma conversa:

   Copilot prompt

   /create-issue
   
   Create a GitHub issue to address the first of the problem areas that you identified.
   
   If the problem area requires substantial work, create one main issue for the entire problem area and then sub-issues that allow the work to be split up into manageable chunks, which will be tackled in separate pull requests that can be easily reviewed. For a large body of work, do not create a single issue that attempts to address the entire problem.
   
   The issue, or each sub-issue if these are created, must include a description of the problem, a set of acceptance criteria, and pointers on what files need to be added/updated.
   

7. Edite esse prompt conforme necessário. Por exemplo, dependendo da resposta que Copilot produziu, talvez você queira trabalhar em outra das áreas problemáticas identificadas Copilot , em vez da primeira.

8. Verifique se o modo Perguntar ainda está selecionado ().

9. Clique ou pressione Enter.

10. Revise o problema de rascunho que Copilot gera, editando-o conforme necessário.

11. Se Copilot criar um único problema de rascunho que indique que os subproblemas devem ser criados, solicite Copilot para que isso seja feito para você:

    Copilot prompt

    Go ahead and create sub-issues that chunk this work into manageable pieces.
    

12. Clique em Criar ou Revisar e Criar, dependendo de quantos itens foram redigidos.

           Copilot cria um ou mais problemas novos em seu nome. Você será mostrado como o autor do problema.
    

4. Obtenha Copilot para corrigir um problema

Agora que você criou problemas, a próxima etapa é delegar um problema Copilot e examinar a solicitação de pull resultante.

1. Abra um dos itens que Copilot criou para você na seção anterior.

2. Verifique se o problema contém critérios de aceitação que Copilot pode usar para verificar se a tarefa foi concluída.

3. Faça as alterações que você achar necessárias para descrever com precisão o problema que precisa ser corrigido e o resultado esperado do trabalho sobre esse problema.

4. Clique Atribuir a Copilot.

5. Em "Atribuir o Copilot ao problema", clique em Atribuir.

          Copilot começará a trabalhar no problema. Após alguns instantes, um link para uma pull request de rascunho será adicionado ao problema.
   

6. Clique no link da pull request do rascunho.

   Depois de Copilot terminar de trabalhar na solicitação de pull, ele removerá "[WIP]" do título da solicitação de pull e adicionará você como revisor.

   Você pode sair Copilot para trabalhar no pull request de forma assíncrona e voltar para revisá-lo depois de ser adicionado à lista de revisores.

7. Opcionalmente, depois que Copilot estiver trabalhando por alguns minutos, você pode clicar em Exibir sessão na solicitação de pull para ver um log do que Copilot está fazendo.

8. Opcionalmente, na guia "Conversa" da solicitação de pull, adicione Copilot como revisor.

9. Depois de ser adicionado como revisor, examine as alterações por conta própria e faça as alterações necessárias.

   Você pode pedir para Copilot fazer alterações por você usando @copilot em um comentário de revisão.

10. Clique em Pronto para revisão na parte inferior da guia "Conversa" da solicitação de pull e conclua seu processo habitual para mesclar uma solicitação de pull.

5. Iterar o processo

1. Se Copilot tiver criado vários problemas, repita a seção 4, atribuindo Copilot a um dos outros problemas.
2. Depois de fechar todos os problemas criados por Copilot, repita a seção 3, escolhendo outra área problemática e repetindo o passo na seção 4 para atribuir problemas a Copilot, examinando e mesclando suas alterações.

Conclusion

          Agente de nuvem Copilot pode ajudá-lo a melhorar a qualidade do código em qualquer projeto, mas é particularmente útil para reduzir a dívida técnica em um projeto que cresceu organicamente ao longo de muitos meses ou anos. Ao usar Agente de nuvem Copilot, você pode fazer melhorias para as quais talvez tenha lutado para encontrar tempo sem que um assistente de IA trabalhe em seu nome.

          Copilot não o substitui como desenvolvedor , você ainda precisa estar envolvido em cada etapa desse processo, especificando o que deseja Copilot fazer e examinando cuidadosamente o código que ele altera ou adiciona, mas permite implementar melhorias ao mesmo tempo que você trabalha em outras tarefas importantes.

Próximas etapas

Leia este estudo de caso no GitHub blog: Como a GitHub equipe de cobrança usa o agente de nuvem em GitHub Copilot para reduzir continuamente a dívida técnica.