Usando GitHub Copilot para explorar uma base de código

Introdução

Se você tiver sido designado para trabalhar em uma project com a qual não está familiarizado ou encontrou uma código aberto project interessante para a qual deseja contribuir, precisará de alguma compreensão da base de código antes de começar a fazer alterações. Este guia mostrará como usar Copilot Chat do GitHub para explorar uma base de código e aprender rapidamente sobre o projeto.

Trabalhar com Bate-papo do Copilot

Ao longo deste guia, trabalharemos com Bate-papo do Copilot no GitHub.com, que você pode encontrar em github.com/copilot.

Fornecendo contexto de repositório

Você pode perguntar Bate-papo do Copilot sobre uma base de código de qualquer uma dessas maneiras.

Anexando um repositório no chat

Anexar um repositório dá Bate-papo do Copilot acesso ao código no repositório e é melhor quando você deseja comparar ou alternar entre repositórios durante uma conversa.

1. No GitHub, navegue até github.com/copilot.
2. Na caixa de texto, clique em Adicionar repositórios, arquivos e espaços e clique em Repositórios.
3. Pesquise e selecione o repositório que você deseja explorar.

Perguntando na página do repositório

Você pode perguntar ao Bate-papo do Copilot sobre um repositório diretamente na sua página no GitHub, sem precisar anexá-lo primeiro. Essa é uma maneira rápida de se orientar em um projeto em que você não trabalhou antes.

1. No GitHub, navegue até o repositório que você deseja explorar.
2. Abra Bate-papo do Copilot na página do repositório e faça uma pergunta. Copilot usa o repositório como contexto e fundamenta suas respostas nos arquivos e símbolos reais do repositório.
3. Faça uma pergunta de acompanhamento para ir mais fundo, usando o mesmo contexto compartilhado.

Prompts de exemplo

Os prompts a seguir são exemplos do tipo de perguntas que você pode fazer Copilot para ajudá-lo a descobrir 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.

• Give me an overview of this repository: its purpose, structure, key components, and how to run it.

• What are the main entry points and how do the key components fit together?

• 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 Copilot para ajudá-lo a entender a finalidade dos arquivos em um diretório ou arquivos individuais.

Para saber mais sobre os arquivos em um diretório:

1. Navegue até o diretório em GitHub.com.

2. No canto superior direito da página, clique no ícone Copilot () para abrir Bate-papo do Copilot.

Copilot usará o conteúdo do diretório como contexto para sua pergunta.

1. Pergunte a Copilot: Explain the files in this directory.

Para saber mais sobre um arquivo específico:

1. Abra o arquivo em GitHub.com.

2. No canto superior direito da página, clique no ícone Copilot () para abrir Bate-papo do Copilot.

Copilot usará o conteúdo do arquivo como contexto para sua pergunta.

1. Para um arquivo pequeno, pergunte Copilot: Explain this file.
2. 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 Copilot para ajudá-lo a entender linhas de código específicas em um arquivo.

Para saber mais sobre uma linha de código específica:

1. No GitHub, navegue até um repositório e abra um arquivo.

2. 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.

3. Para fazer sua própria pergunta sobre as linhas selecionadas, clique no Copilot ícone () à direita de sua seleção. Isso exibe o Copilot Chat do GitHub painel com as linhas selecionadas indicadas como o contexto de sua pergunta.

4. Para fazer uma pergunta predefinida, clique no botão apontando para baixo ao lado do Copilot ícone e escolha uma das opções.

   

5. Se você clicou no Copilot ícone, 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 Copilot para ajudá-lo 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.

1. No GitHub, navegue até um repositório e abra um arquivo.

2. Na parte superior do arquivo, clique no Copilot ícone () para abrir Bate-papo do Copilot.

Copilot exibirá o conteúdo do arquivo em uma tela dividida como contexto para sua pergunta.

1. Se você quiser perguntar sobre um símbolo específico, realce o símbolo no arquivo.

2. Na caixa de prompt, digite uma pergunta sobre o arquivo ou o símbolo realçado e pressione Enter.

Copilot respostas no painel de chat.

Descobrir mais sobre os commits

Uma boa maneira de se familiarizar com um projeto é ver o trabalho recente que está sendo feito. Você pode navegar pelos commits recentes para fazer isso.

1. Em GitHub, acesse a página principal do repositório.

2. Na página principal do repositório, acima da lista de arquivos, clique em commits.

   

3. Clique em uma mensagem de commit para exibir uma visualização das diferenças para esse commit.

4. No painel Bate-papo do Copilot, insira: What does this commit do?.

5. Se necessário, você pode acompanhar inserindo: Explain in more detail.

Usando a aba Insights

Além de usar Copilot para ajudar você a se familiarizar com um projeto, você também pode usar a guia Insights em 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

• Fazer perguntas ao GitHub Copilot no GitHub