GitHub Copilot Instruction MD 설정 가이드

GitHub Copilot은 개발자들에게 코드 작성과 관련된 다양한 제안을 제공하는 AI 도구로, 프로젝트의 특성이나 팀의 작업 방식에 맞게 조정할 수 있습니다. 이러한 사용자 지정을 위해 리포지토리 수준에서의 사용자 지정 지침을 활용할 수 있습니다. 이 블로그 글에서는 GitHub Copilot의 리포지토리 사용자 지정 지침에 대해 알아보고, 이를 설정하는 방법과 활용 방안을 소개하겠습니다.

리포지토리 사용자 지정 지침이란?

GitHub Copilot은 충분한 컨텍스트를 제공받으면 팀의 작업 방식, 사용하는 도구, 프로젝트의 세부 사항에 맞게 채팅 응답을 조정할 수 있습니다. 채팅 질문에 이러한 컨텍스트 정보를 반복적으로 추가하는 대신, 리포지토리에 지침 파일을 만들어 Copilot이 자동으로 이 정보를 활용하도록 할 수 있습니다. 이러한 지침은 채팅에 직접 표시되지는 않지만, Copilot이 더 높은 품질의 응답을 생성하는 데 도움을 줍니다.

사용자 지정 지침 파일 생성 방법

리포지토리 수준에서 Copilot의 동작을 사용자 지정하려면, 다음과 같은 단계를 따라 .github/copilot-instructions.md 파일을 생성해야 합니다:

1. 파일 생성 위치: 리포지토리의 루트 디렉터리에 .github 폴더를 생성합니다. 이미 존재한다면 이 단계를 건너뛸 수 있습니다.
2. 지침 파일 생성: .github 폴더 내에 copilot-instructions.md 파일을 생성합니다.
3. 지침 작성: 이 파일에 자연어로 작성된 지침을 Markdown 형식으로 추가합니다. 예를 들어, 특정 코딩 스타일이나 사용해야 하는 라이브러리, 테스트 프레임워크 등에 대한 지침을 포함할 수 있습니다.

이렇게 생성된 지침 파일은 저장되는 즉시 Copilot Chat에서 활용되며, 해당 리포지토리와 관련된 모든 채팅 프롬프트에 자동으로 적용됩니다.

사용자 지정 지침 활용 예시

프로젝트의 특성에 따라 다양한 지침을 설정할 수 있습니다. 몇 가지 예시는 다음과 같습니다:

• 코딩 스타일: "모든 함수 이름은 카멜케이스(camelCase)로 작성해주세요."
• 사용할 라이브러리: "HTTP 요청을 보낼 때 Axios 라이브러리를 사용해주세요."
• 테스트 프레임워크: "단위 테스트는 Jest를 사용하여 작성해주세요."

이러한 지침을 통해 Copilot이 프로젝트의 규칙과 표준을 준수하는 코드를 제안하도록 유도할 수 있습니다.

사용자 지정 지침의 활성화 및 비활성화

사용자 지정 지침의 적용 여부는 개인 설정에서 조정할 수 있습니다. 기본적으로 이 기능은 활성화되어 있지만, 필요에 따라 비활성화할 수 있습니다:

1. 설정 열기: IDE의 설정 메뉴를 엽니다.
2. 지침 파일 설정 검색: 검색 창에 instruction file을 입력하여 관련 설정을 찾습니다.
3. 사용자 지정 지침 사용 여부 설정: 'Use Instruction Files' 옵션을 찾아 활성화 또는 비활성화합니다.

이러한 설정을 통해 프로젝트별로 Copilot의 동작을 세밀하게 제어할 수 있습니다.

마치며

GitHub Copilot의 리포지토리 사용자 지정 지침 기능은 팀과 프로젝트의 고유한 요구 사항에 맞게 AI 도구를 최적화할 수 있는 강력한 방법입니다. 이 기능을 활용하여 개발 효율성과 코드 품질을 향상시킬 수 있기를 바랍니다.

 

참고: https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot