GitHub Copilot를 사용하여 코드베이스 탐색

깃허브 코파일럿 채팅은 코드베이스의 콘텐츠, 구조, 기능을 이해하는 데 도움이 될 수 있습니다.

이 기사에서

소개

익숙하지 않은 project 작업하도록 할당되었거나 기여하려는 흥미로운 open source project 찾은 경우 변경 작업을 시작하기 전에 코드베이스에 대한 이해가 필요합니다. 이 가이드는 깃허브 코파일럿 채팅를 사용하여 코드베이스를 탐색하고 프로젝트에 대해 빠르게 학습하는 방법을 보여줍니다.

공동 파일럿 채팅와 함께 작업하기

이 가이드에서는 공동 파일럿 채팅의 GitHub.com을(를) github.com/copilot에서 활용하는 방법을 함께 살펴보겠습니다.

코드베이스 연결

공동 파일럿 채팅를 효과적으로 활용하려면 우선 탐색하고자 하는 코드베이스와의 연결이 필요합니다.

  1. GitHub에서 github.com/copilot 이동합니다.
  2. 텍스트 상자에서 리포지토리, 파일 및 스페이스 추가, 그리고 리포지토리를 클릭합니다.
  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 아이콘()을 클릭하세요. 그러면 선택한 줄이 질문의 컨텍스트로 표시된 깃허브 코파일럿 채팅 패널이 표시됩니다.

  4. 미리 정의된 질문을 하려면 Copilot 아이콘 옆에 있는 아래쪽 화살표 버튼을 클릭한 다음 옵션 중 하나를 선택합니다.

    선택한 코드 오른쪽에 진한 주황색 윤곽선으로 강조 표시된 Copilot 버튼 스크린샷

  5. Copilot 아이콘을 클릭한 경우, 채팅 패널 아래쪽의 프롬프트 상자에 질문을 입력하고 Enter 키를 누릅니다.

특정 파일 또는 기호 이해

Copilot을 사용하여 코드베이스에서 특정 파일 또는 기호의 용도를 이해할 수 있습니다. 기호는 함수, 클래스 또는 변수와 같은 코드의 명명된 엔터티입니다.

  1. GitHub에서 리포지토리로 이동하여 파일을 엽니다.

  2. 파일 맨 위에서 Copilot 아이콘 ()을 클릭하여 공동 파일럿 채팅을 엽니다.

    Copilot은(는) 화면을 분할하여 파일 내용을 질문과 관련된 컨텍스트로 표시합니다.

  3. 특정 기호에 대해 물어보려면 파일의 기호를 강조 표시합니다.

  4. 프롬프트 상자에 파일이나 강조 표시된 기호에 대한 질문을 입력한 후, Enter 키를 누릅니다.

    Copilot이(가) 채팅 패널에 응답합니다.

    팁

    리포지토리 컨텍스트에서 이와 같은 자연어 질문에 답할 수 있는 Copilot의 기능은 리포지토리의 의미 체계 코드 검색 인덱스가 최신일 때 최적화됩니다. 자세한 내용은 GitHub Copilot을 위한 리포지토리 인덱싱을(를) 참조하세요.

커밋에 대해 알아보기

project 익숙해지는 좋은 방법 중 하나는 최근 일어나고 있는 작업을 살펴보는 것입니다. 최근 커밋을 탐색하면 이 작업을 수행할 수 있습니다.

  1. GitHub에서 리포지토리의 기본 페이지로 이동합니다.

  2. 리포지토리의 기본 페이지에서 파일 목록 위에 있는 커밋을 클릭합니다.

    리포지토리의 기본 페이지 스크린샷 시계 아이콘과 "178개의 커밋"이 주황색 윤곽선으로 강조 표시되어 있습니다.

  3. 커밋 메시지를 클릭하면 해당 커밋에 대한 Diff 보기가 표시됩니다.

  4. 공동 파일럿 채팅 패널에 What does this commit do?를 입력하세요.

  5. 필요한 경우 Explain in more detail을 입력하여 후속 작업을 수행할 수 있습니다.

Insights 탭 사용

Copilot를 사용하여 프로젝트에 익숙해지는 데 도움을 받는 것 외에도, GitHub.com의 인사이트 탭을 활용할 수 있습니다. 리포지토리의 개략적인 개요를 제공합니다.

자세한 내용은 Pulse를 사용하여 리포지토리 활동 요약 보기 및 프로젝트의 기여자 보기을(를) 참조하세요.

추가 참고 자료