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

GitHub Copilot 채팅은 코드베이스의 콘텐츠, 구조, 기능을 이해하는 데 도움이 될 수 있습니다.

이 문서의 내용

소개

익숙하지 않은 프로젝트를 맡도록 할당되었거나, 참여하고 싶은 흥미로운 오픈 소스 프로젝트를 발견하게 되었다면, 변경 작업을 시작하기 전에 코드베이스에 대한 이해가 필요합니다. 이 가이드에서는 GitHub Copilot 채팅을 사용하여 코드베이스를 탐색하고 프로젝트를 빠르게 알아가는 방법을 알려줍니다.

Copilot 채팅으로 작업하기

이 가이드에서는 GitHub.com에서 Copilot 채팅을 보조 모드로 사용하여 작업합니다. 이 모드에서는 GitHub.com의 현재 페이지 오른쪽 하단에 Copilot 채팅 패널이 표시됩니다.

Copilot의 응답을 표시할 공간을 늘리려면 패널의 가장자리를 클릭하고 드래그하여 Copilot 채팅 패널을 확장할 수 있습니다.

미리 정의된 프롬프트 사용

Copilot 채팅에는 코드베이스 탐색을 시작하는 데 도움이 되는 미리 정의된 프롬프트 세트가 함께 제공됩니다. 채팅 패널에서 단추를 클릭하여 프롬프트를 사용할 수 있습니다. Copilot 채팅으로 새로운 대화를 시작하면 단추가 표시됩니다. 프롬프트 선택 항목은 GitHub.com에 현재 표시된 페이지에 따라 달라집니다.

  1. GitHub.com에서 탐색하려는 리포지토리를 엽니다.

  2. Code 탭을 클릭하여 리포지토리의 기본 페이지를 표시합니다.

  3. Shift+C를 눌러 보조 모드에서 Copilot 채팅을 엽니다.

  4. 채팅 패널에서 Tell me about this repository 단추를 클릭하세요.

    'Tell me about this repository' 단추가 강조 표시된 채팅 패널의 스크린샷

    팁

    이 단추가 표시되지 않는 경우, 리포지토리의 기본 페이지에서 작업 중인지 확인한 후, Copilot 패널 오른쪽 상단에 있는 더하기 기호()를 클릭하여 새 대화를 시작하세요.

    미리 정의된 프롬프트가 Copilot에 제출되고 관련 응답이 채팅 패널에 표시됩니다.

  5. 필요에 따라 응답을 읽은 후 Copilot 패널의 오른쪽 위에 있는 더하기 기호()를 클릭하여 새 대화를 시작한 다음, How to get started with this repository를 클릭합니다.

예시 프롬프트

다음 프롬프트는 코드베이스에 대해 알아내는 데 도움이 되는 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. Shift+C를 눌러 보조 모드에서 Copilot 채팅을 엽니다.
  3. Copilot에게 Explain the files in this directory를 묻습니다.

특정 파일에 대해 알아보려면:

  1. GitHub.com에서 해당 파일을 엽니다.
  2. Shift+C를 눌러 보조 모드에서 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.을 묻습니다.

커밋에 대해 알아보기

프로젝트를 숙지하는 좋은 방법 중 하나는 최근 진행된 작업을 살펴보는 것입니다. 최근 커밋을 탐색하면 이 작업을 수행할 수 있습니다.

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

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

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

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

  4. Copilot 채팅 패널에 What does this commit do?를 입력하세요.

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

Insights 탭 사용

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

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

추가 참고 자료