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 GitHub Copilot Chat para explorar uma base de código e aprender rapidamente sobre o projeto.
Trabalhando com o Copilot Chat
Neste guia, trabalharemos no GitHub.com, usando o Copilot Chat no modo assistencial, que exibe um painel do Copilot Chat no canto inferior direito da página atual no GitHub.com.
Você pode expandir o painel do Copilot Chat para dar mais espaço para exibir as respostas do Copilot clicando e arrastando as bordas do painel.
Usando os prompts predefinidos
O Copilot Chat vem com um conjunto de prompts predefinidos que podem ajudar você a começar a explorar uma base de código. Você pode usar os prompts clicando em um botão no painel de chat. Os botões são exibidos quando você inicia uma nova conversa com o Copilot Chat. A seleção de prompts varia dependendo da página exibida no momento no GitHub.com.
-
Abra o repositório que deseja explorar no GitHub.com.
-
Clique na guia Code para exibir a página principal do repositório.
-
Pressione Shift+C para abrir o Copilot Chat no modo assistencial.
-
Clique no botão Tell me about this repository no painel de chat.
Dica
Se esse botão não for exibido, verifique se você está na página principal do repositório e clique no sinal de adição () no canto superior direito do painel do Copilot para iniciar uma nova conversa.
Um prompt predefinido é enviado ao Copilot e a resposta é exibida no painel de chat.
-
Opcionalmente, depois de ler a resposta, clique no sinal de adição () no canto superior direito do painel do Copilot para iniciar uma nova conversa e clique em How to get started with this repository.
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.
- Pressione Shift+C para abrir o Copilot Chat no modo assistencial.
- Pergunte ao Copilot:
Explain the files in this directory.
Para saber mais sobre um arquivo específico:
- Abra o arquivo no GitHub.com
- Pressione Shift+C para abrir o Copilot Chat no modo assistencial.
- 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.
Descobrindo sobre commits
Uma boa maneira de se familiarizar com um projeto é olhar para o trabalho recente que vem acontecendo. Você pode fazer isso navegando pelos commits recentes.
-
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 do commit para exibir uma exibição comparativa dele.
-
No painel do Copilot Chat, insira:
What does this commit do?. -
Se necessário, você pode acompanhar inserindo:
Explain in more detail.
Usando a guia Insights
Além de usar o Copilot para ajudar você a se familiarizar com um projeto, você também pode usar a guia 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.