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

Введение

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

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

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

Прикрепление кодовой базы

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

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

Копилот Чат теперь имеет доступ к коду в этом репозитории, и вы можете начать задавать вопросы по этому поводу.

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

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

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

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

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

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

• 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 будет использовать содержимое каталога в качестве контекста для вашего вопроса.

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

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

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

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

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

3. Для небольшого файла попросите Copilot: Explain this file

4. Для большого файла попросите: 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 отображает содержимое файла на разделённом экране в качестве контекста для вашего вопроса.

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

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

   Ответы Copilot на панели чата.

   Совет

   Copilotвозможности ответов на вопросы естественного языка, такие как эти в контексте репозитория, оптимизированы при актуальном индексе поиска семантического кода для репозитория. Дополнительные сведения см. в разделе Индексирование репозиториев для чата GitHub Copilot.

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

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

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

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

•         [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github)