Использование GitHub Copilot для изучения кодовой базы

Введение

Если вам поручили работать над project, с которым вы не знакомы, или вы нашли интересный открытый код project, в который хотите внести вклад — вам нужно понимать кодовую базу, прежде чем начинать вносить изменения. В этом руководстве показано, как использовать Чат GitHub Copilot для изучения базы кода и быстро узнать о проекте.

Работа с Копилот Чат

В рамках этого руководства мы будем работать над Копилот ЧатGitHub.comтем, с которыми можно ознакомиться github.com/copilot.

Предоставление контекста репозитория

Вы можете спросить Копилот Чат о базе кода в любом из этих способов.

Присоединение репозитория в чате

Присоединение репозитория предоставляет Копилот Чат доступ к коду в репозитории и лучше всего, если вы хотите сравнить или переключиться между репозиториями во время беседы.

1. В GitHubпротивном случае перейдите к github.com/copilot.
2. В текстовом поле нажмите кнопку "Добавить репозитории", "Файлы" и "Пробелы", а затем нажмите кнопку "Репозитории".
3. Найдите и выберите репозиторий, который хотите исследовать.

Запрос с страницы репозитория

Вы можете задать вопрос Копилот Чат о репозитории непосредственно с страницы GitHub, не вложив его в первую очередь. Это быстрый способ получить ориентацию в проекте, над который вы еще не работали.

1. В GitHubпротивном случае перейдите в репозиторий, который вы хотите изучить.
2. Откройте Копилот Чат страницу репозитория и задайте вопрос. Copilot использует репозиторий в качестве контекста и определяет его ответы в фактических файлах и символах репозитория.
3. Задайте дальнейший вопрос, чтобы перейти к более глубокому, используя тот же общий контекст.

Примеры запросов

Ниже приведены примеры вопросов, которые вы можете задать Copilot , чтобы узнать о базе кода.

Общие вопросы

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

Конкретные вопросы

Будут ли эти вопросы полезны, зависят ли эти вопросы от базы кода, которую вы изучаете.

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

Общие сведения о файлах в каталоге

Используйте Copilot для понимания цели файлов в каталоге или отдельных файлах.

Чтобы узнать о файлах в каталоге, выполните следующие действия.

1. Перейдите в каталог GitHub.com.

2. В правом верхнем углу страницы нажмите на значок Copilot (), чтобы открыть Копилот Чат.

Copilot будет использовать содержимое каталога в качестве контекста для вашего вопроса.

1. Спросите Copilot: Explain the files in this directory.

Чтобы узнать о конкретном файле, выполните указанные действия.

1. Откройте файл GitHub.comв .

2. В правом верхнем углу страницы нажмите на значок Copilot (), чтобы открыть Копилот Чат.

Copilot будет использовать содержимое файла в качестве контекста для вашего вопроса.

1. Для небольшого файла попросите Copilot: Explain this file.
2. Для большого файла попросите: 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.

Общие сведения о конкретных строках кода

Используйте Copilot для понимания конкретных строк кода в файле.

Чтобы узнать о определенной строке кода, выполните указанные ниже действия.

1. В противном случае GitHubперейдите к репозиторию и откройте файл.

2. Выберите строки, щелкнув номер строки для первой строки, удерживая клавишу SHIFT и щелкнув номер строки для последней строки, которую вы хотите выбрать.

3. Чтобы задать собственный вопрос о выбранных строках, щелкните Copilot значок () справа от выбранного фрагмента. Откроется Чат GitHub Copilot панель с выбранными строками, указанными в контексте вопроса.

4. Чтобы задать предопределенный вопрос, нажмите кнопку вниз рядом Copilot с значком, а затем выберите один из вариантов.

   

5. Если щелкнуть Copilot значок, введите вопрос в поле запроса в нижней части панели чата и нажмите клавишу ВВОД.

Общие сведения о конкретном файле или символе

Используйте Copilot для понимания цели определенного файла или символа в базе кода. Символ является именованной сущностью в коде, например функцией, классом или переменной.

1. В противном случае GitHubперейдите к репозиторию и откройте файл.

2. В верхней части файла щелкните Copilot значок (), чтобы открыть Копилот Чат.

Copilot будет отображать содержимое файла в разделенном экране в качестве контекста для вашего вопроса.

1. Если хотите спросить о конкретном символе, выделите этот символ в файле.

2. В поле запроса введите вопрос о файле или выделенном символе и нажмите Enter.

Copilot Ответы в чате.

Сведения о фиксациях

Один из хороших способов познакомиться с project — изучить недавние работы. Это можно сделать, просматривая последние фиксации.

1. На GitHubперейдите на главную страницу репозитория.

2. На главной странице репозитория над списком файлов щелкните фиксации.

   

3. Щелкните сообщение фиксации, чтобы отобразить представление диффа для этой фиксации.

4. Копилот Чат На панели введите: What does this commit do?

5. При необходимости можно выполнить следующие действия, введя следующее: Explain in more detail

Использование вкладки "Аналитика"

Помимо использования Copilot для ознакомления с проектом, вы также можете использовать вкладку GitHub.com**"Аналитика**". Это дает общий обзор репозитория.

Дополнительные сведения см. в разделе [AUTOTITLE и Использование Pulse для просмотра сводки действий репозитория](/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors).

Дополнительные материалы

• автозаголовок