Introdução
Se você foi encarregado de trabalhar em um projeto com o qual não está familiarizado — ou encontrou um projeto de software livre interessante com o qual deseja contribuir —, precisa ter alguma compreensão da base de código antes de começar a fazer alterações. Este guia mostra como usar o Chat GitHub Copilot para explorar uma base de código e aprender rapidamente sobre o projeto.
Trabalhando com Chat Copilot
Ao longo deste guia, trabalharemos com Chat Copilot em GitHub.com, que você pode encontrar em GitHub.com/copilot.
Anexando uma base de código
Antes que Chat Copilot possa ajudá-lo, você precisa anexar a base de código que deseja explorar.
- Em , navegue até GitHub.com/copilot.
- Na caixa de texto, clique em Adicionar repositórios, arquivos e espaços e clique em Repositórios.
- Pesquise e selecione o repositório que você deseja explorar.
Agora Chat Copilot tem acesso ao código desse repositório, e você pode começar a tirar suas dúvidas sobre ele.
Prompts de exemplo
Os prompts a seguir são exemplos do tipo de perguntas que você pode fazer ao Copilot para saber mais sobre uma base de código.
Perguntas gerais
-
Based on the code in this repository, give me an overview of the architecture of the codebase. Provide evidence. -
Which languages are used in this repo? Show the percentages for each language. -
What are the core algorithms implemented in this repo? -
What design patterns are used in this repository? Give a brief explanation of each pattern that you find, and an example of code from this repository that uses the pattern, with a link to the file.
Perguntas específicas
A utilidade dessas perguntas dependerá da base de código que você está explorando.
-
How do I build this project? -
Where is authentication handled in this codebase? -
Analyze the code in this repository and tell me about the entry points for this application. -
Describe the data flow in this application. -
Analyze the code in this repository and tell me what application-level security mechanisms are employed. Provide references.
Compreensão dos arquivos em um diretório
Use o Copilot para ajudar você a entender a finalidade dos arquivos em um diretório ou arquivos individuais.
Para saber mais sobre os arquivos em um diretório:
-
Navegue até o diretório no GitHub.com.
-
No canto superior direito da página, clique no ícone Copilot () para abrir Chat Copilot.
Copilot usará o conteúdo do diretório como contexto para a sua pergunta.
-
Pergunte ao Copilot:
Explain the files in this directory.
Para saber mais sobre um arquivo específico:
-
Abra o arquivo no GitHub.com
-
No canto superior direito da página, clique no ícone Copilot () para abrir Chat Copilot.
Copilot utilizará o conteúdo do arquivo como contexto para sua pergunta.
-
Para um arquivo pequeno, pergunte Copilot:
Explain this file. -
Para um arquivo grande, pergunte:
Explain what this file does. Start with an overview of the purpose of the file. Then, in appropriately headed sections, go through each part of the file and explain what it does in detail.
Entender linhas de código específicas
Use o Copilot para ajudar a entender linhas de código específicas em um arquivo.
Para saber mais sobre uma linha de código específica:
-
Em , navegue até um repositório e abra um arquivo.
-
Selecione as linhas clicando no número da primeira linha que você deseja selecionar, mantendo pressionada a tecla Shift e clicando no número da última linha que deseja selecionar.
-
Para fazer sua própria pergunta sobre as linhas selecionadas, clique no ícone do Copilot () à direita da sua seleção. Isso exibe o painel do Chat GitHub Copilot com as linhas selecionadas indicadas como contexto da pergunta.
-
Para fazer uma pergunta predefinida, clique no botão apontando para baixo, ao lado do ícone do Copilot. Depois, escolha uma das opções.
-
Se você clicou no ícone do Copilot, digite uma pergunta na caixa de prompt na parte inferior do painel de chat e pressione Enter.
Entender um arquivo ou símbolo específico
Use o Copilot para ajudar você a entender a finalidade de um arquivo ou símbolo específico na base de código. Um símbolo é uma entidade nomeada no código, como uma função, classe ou variável.
-
Em , navegue até um repositório e abra um arquivo.
-
Na parte superior do arquivo, clique no ícone Copilot. () para abrir Chat Copilot.
Copilot exibirá o conteúdo do arquivo em modo de tela dividida como contexto para sua pergunta.
-
Se você quiser perguntar sobre um símbolo específico, realce o símbolo no arquivo.
-
Na caixa de prompt, digite uma pergunta sobre o arquivo ou o símbolo realçado e pressione Enter.
O Copilot fornece respostas no painel de bate-papo.
Dica
A capacidade do Copilot de responder a perguntas em linguagem natural como essas em um contexto de repositório é otimizada quando o índice de pesquisa de código semântico do repositório está atualizado. Para saber mais, confira Indexar repositórios para o GitHub Copilot Chat.
Descobrir mais sobre os commits
Uma boa maneira de se familiarizar com um projeto é olhar para o trabalho recente que vem acontecendo. Você pode navegar pelos commits recentes para fazer isso.
-
Em GitHub, acesse a página principal do repositório.
-
Na página principal do repositório, acima da lista de arquivos, clique em commits.
-
Clique em uma mensagem de commit para exibir uma visualização das diferenças para esse commit.
-
No painel do Chat Copilot, insira:
What does this commit do?. -
Se necessário, você pode acompanhar inserindo:
Explain in more detail.
Usando a aba Insights
Além de usar o Copilot para ajudar você a se familiarizar com um projeto, você também pode acessar a aba Insights no GitHub.com. Isso fornece uma visão geral de alto nível do repositório.
Para saber mais, confira Usar o Pulse para exibir um resumo da atividade do repositório e Exibir contribuidores do projeto.
Leitura adicional
-
[AUTOTITLE](/copilot/using-GitHub-copilot/copilot-chat/asking-GitHub-copilot-questions-in-GitHub)