명령 파일을 사용하여 GitHub Copilot 응답 사용자 지정

Completed

사용자 지정 명령 파일은 팀의 코딩 표준, 아키텍처 결정 및 프로젝트별 지침을 리포지토리에 직접 포함하는 방법을 제공합니다. GitHub Copilot Chat은 요청을 처리할 때 이러한 파일을 읽고 해당 콘텐츠를 응답에 통합하여 모든 프롬프트에서 동일한 컨텍스트를 반복할 필요 없이 프로젝트의 규칙에 맞는 제안을 생성합니다.

"Always-On" 사용자 지정 지침

리포지토리 수준 지침의 기본 메커니즘은 리포지토리 또는 작업 영역의 루트에 배치된 Markdown 파일입니다 .github/copilot-instructions.md . 이 파일은 해당 프로젝트 내의 모든 GitHub Copilot 채팅 상호 작용에 적용되는 추가 컨텍스트 및 규칙을 GitHub Copilot에 제공합니다. 지침은 모든 GitHub Copilot 채팅 프롬프트에 자동으로 포함되며 AI에 대한 상시 지침 역할을 합니다.

예를 들어 파일이 "클래스 이름에 PascalCase를 사용하고 지역 변수에 camelCase를 사용" 또는 "데이터 액세스 클래스에 항상 리포지토리 패턴 사용"을 지정하는 경우 .github/copilot-instructions.md GitHub Copilot는 이러한 규칙을 제안에 통합합니다. 이 기능은 AI 생성 코드를 팀 지침에 맞게 조정하는 데 필요한 수동 편집의 양을 줄여 코드베이스 전체에서 효율성과 일관성을 향상시킵니다.

지침은 Markdown 서식을 사용하여 자연어로 작성됩니다. 각 지침은 자체 글머리 기호 또는 단락일 수 있습니다. 지침 사이의 공백은 모델로 전송될 때 무시되므로 GitHub Copilot에서 처리하는 방식에 영향을 주지 않고 가독성을 위해 파일의 서식을 지정할 수 있습니다.

GitHub Copilot Chat에서 /init 슬래시 커맨드를 사용하여 프로젝트에 대한 copilot-instructions.md 파일을 자동으로 생성할 수 있습니다. GitHub Copilot는 작업 영역을 분석하고 프로젝트의 언어, 프레임워크 및 구조에 맞게 조정된 시작 명령 파일을 생성합니다.

비고

Visual Studio Code는 AGENTS.md 파일 및 CLAUDE.md 파일을 항상 활성화된 지침으로 지원합니다. AGENTS.md 작업 영역의 루트에 배치된 파일은 copilot-instructions.md처럼 유사하게 작동하며, 여러 AI 에이전트로 작업하고 모든 AI 에이전트가 인식할 수 있는 단일 명령 집합을 원하는 경우에 유용합니다. CLAUDE.md 파일은 동일한 패턴을 따릅니다. 또한 중첩된 AGENTS.md 파일을 하위 디렉터리에 배치하여 GitHub Copilot가 해당 디렉터리 또는 해당 자식 내의 파일에서 작동하는 경우에만 적용되는 컨텍스트별 지침을 제공할 수 있습니다.

경로 지정 지침

코드베이스의 여러 부분에 다른 지침이 필요한 프로젝트의 경우 확장자를 사용하여 .instructions.md 파일 기반 명령 파일을 만들 수 있습니다. 이러한 파일은 디렉터리(또는 작업 영역 간 사용을 위한 사용자 프로필)에 저장 .github/instructions/ 되며 적용할 파일 또는 파일 패턴을 지정하는 필드가 있는 applyTo YAML 프런트매터 헤더를 포함합니다.

예를 들어 이름이 지정된 database.instructions.mdapplyTo: "DataAccess/**/*.cs" 파일에는 DataAccess 폴더의 C# 파일에만 적용되는 규칙(예: "데이터 액세스 클래스에 리포지토리 패턴 사용" 또는 "SQL 삽입을 방지하기 위해 항상 매개 변수가 있는 쿼리 포함")이 포함될 수 있습니다. GitHub Copilot가 지정된 패턴과 일치하는 파일로 작업하는 경우 리포지토리 전체 명령과 관련 경로 관련 지침을 모두 병합하여 상황에 맞는 적절한 제안을 생성합니다.

다음 예제에서는 YAML 프런트매터가 있는 경로별 지침 파일을 보여 줍니다.

---
name: 'C# Backend Standards'
description: 'Coding conventions for C# backend files'
applyTo: 'src/Backend/**/*.cs'
---
# C# backend coding standards
- Use PascalCase for public members and camelCase for private fields.
- Prefix private fields with an underscore (e.g., _orderService).
- Use async/await for all I/O-bound operations.
- Include XML documentation comments on all public methods.

YAML 프런트매터는 다음 필드를 지원합니다.

  • applyTo: 명령을 트리거하는 파일을 결정하는 glob 패턴입니다. 일반적인 패턴에는 **/*.cs 모든 C# 파일과 일치하거나, src/Frontend/**/*.ts 특정 디렉터리의 TypeScript 파일을 일치하거나 **/Tests/**/*.cs , 프로젝트 전체의 테스트 파일을 일치시킬 수 있습니다. 파일의 경로가 패턴과 applyTo 일치하면 GitHub Copilot는 일반 리포지토리 지침과 함께 해당 지침을 자동으로 포함합니다.

  • description: 지침에서 다루는 내용에 대한 자연어 설명입니다. GitHub Copilot는 의미 체계 일치를 위해 이 필드를 사용합니다. 채팅에서 질문을 하면 GitHub Copilot는 설명을 평가하여 패턴과 일치하는 applyTo 파일이 열려 있지 않더라도 지침이 현재 컨텍스트와 관련이 있는지 여부를 확인합니다. 예를 들어 "데이터베이스 마이그레이션 스크립트에 대한 지침"에 대한 설명은 데이터베이스 마이그레이션에 대해 질문할 때 GitHub Copilot가 이러한 지침을 포함하는 데 도움이 됩니다.

  • 이름: 채팅 지침 메뉴 및 진단 보기에 표시되는 명령 집합의 표시 이름입니다.

조직 수준 지침

여러 리포지토리에서 코딩 표준을 유지하는 기업의 경우 GitHub는 조직 수준 지침을 지원합니다. 이러한 지침은 GitHub 조직 수준에서 정의되며 조직 내의 모든 리포지토리에 적용됩니다. 이 동작은 팀 전체에서 일관성을 보장합니다. 예를 들어 공유 보안 코딩 표준 또는 아키텍처 지침을 조직 전체에 적용하여 모든 프로젝트가 동일한 기준선으로 시작되도록 할 수 있습니다.

Visual Studio Code에서 사용자 지정 지침이 구성된 조직에 액세스할 수 있는 GitHub 계정에 로그인하면 조직 수준 지침이 자동으로 검색됩니다. 이러한 지침은 채팅 지침 메뉴의 개인 및 작업 영역 지침과 함께 표시됩니다.

비고

여러 유형의 사용자 지정 명령이 있는 경우 GitHub Copilot는 모든 명령을 포함하지만 충돌을 해결할 때 우선 순위 순서를 따릅니다. 가장 높은 순서에서 가장 낮은 명령 우선 순위 체인은 다음과 같습니다.

  1. 수동으로 채팅 지침 메뉴에 입력되거나 대화에 고정된 지침입니다.
  2. .instructions.md 파일(경로별 지침).
  3. .github/copilot-instructions.md (리포지토리 전체 지침).
  4. AGENTS.md 또는 CLAUDE.md 파일
  5. GitHub 조직 관리자가 구성한 조직 수준 지침입니다.

충돌이 발생할 때 우선 순위가 높은 지침이 우선적으로 적용됩니다.

명령 파일을 만드는 방법

사용자 지정 명령 파일을 만들 때는 몇 가지 간단한 단계가 포함됩니다.

기능을 활성화하세요.

Visual Studio Code의 GitHub Copilot 채팅 설정에서 .github 파일의 사용자 지정 지침이 사용 설정되었는지 확인합니다. 이 설정은 기본적으로 사용하도록 설정됩니다. Visual Studio Code에서 chat.includeApplyingInstructions 설정을 확인하여 확인할 수 있습니다.

.github/copilot-instructions.md 추가

리포지토리의 루트에 .github 폴더가 아직 없으면 만드세요. 이 폴더 내에서 .라는 파일을 만듭니다 copilot-instructions.md. Markdown 서식을 사용하여 자연어로 지침을 작성합니다. 다음은 그 예입니다.

# Project coding guidelines
- Use PascalCase for class names and public members.
- Prefix private fields with an underscore (e.g., _logger).
- Follow the repository pattern for all data access operations.
- Use async/await for I/O-bound operations.
- Include error handling with try-catch blocks for all external API calls.
- Add XML documentation comments on all public methods and classes.

이러한 지침은 리포지토리의 모든 GitHub Copilot 채팅 프롬프트에 자동으로 추가되므로 개발자의 추가 작업 없이 모든 응답에 영향을 줍니다.

.instructions.md 파일 추가(필요한 경우)

프로젝트의 특정 파일 형식 또는 섹션을 대상으로 지정하려면 아래에 instructions하위 폴더를 .github 만듭니다. 이름(예: .instructions.md 또는 logging.instructions.md)으로 끝나는 sql.instructions.md 하나 이상의 Markdown 파일을 추가합니다. 각 파일의 맨 위에 명령이 적용되어야 하는 파일 경로 패턴(glob 패턴)을 나열하는 필드가 있는 YAML 헤더 applyTo 를 포함합니다. 그런 다음, Markdown 본문에 특수한 지침을 작성합니다.

예를 들어, logging.instructions.md 파일은 특정 로깅 프레임워크를 사용하는 방법에 대한 지침을 지정하고 applyTo: "**/*Logger.cs" 을 포함할 수 있습니다. 활성 파일의 경로가 applyTo 패턴과 일치하는 경우 GitHub Copilot는 일반 리포지토리 지침과 해당 컨텍스트에 대한 관련 경로별 지침을 결합합니다.

확인

GitHub Copilot가 지침을 사용하고 있는지 확인하려면 GitHub Copilot 채팅 응답의 참조 섹션을 확인합니다. 사용자 지정 명령이 적용되면 명령 파일이 인용 참조로 표시됩니다. 설정에서 기능이 활성화되어 있는지, 파일 경로와 이름이 예상된 규칙을 따르는지 확인하여 지침이 인식되지 않는 문제를 해결하세요.

채팅 사용자 지정 진단 보기를 사용하여 로드된 모든 명령 파일 및 오류를 볼 수도 있습니다. 채팅 보기를 마우스 오른쪽 단추로 클릭하고 진단을 선택하여 현재 상태를 검사 합니다 .

사용자 지정 지침의 이점

리포지토리 수준 지침은 AI 출력을 팀 규칙에 맞게 조정하고 각 제안에 필요한 수동 편집을 줄입니다. 다음은 사용자 지정 지침이 개발 환경을 개선하는 몇 가지 방법입니다.

  • 명명 규칙: 모든 GitHub Copilot 제안에서 "프라이빗 C# 필드는 밑줄로 시작해야 함" 또는 "공용 속성에 PascalCase 사용"과 같은 패턴을 적용합니다.

  • 라이브러리 및 프레임워크 사용: "로깅에 사용 Serilog " 또는 "입력 유효성 검사에 사용 FluentValidation "과 같은 기본 라이브러리를 지정합니다. 따라서 GitHub Copilot는 팀에서 사용하지 않기로 선택한 대안을 제안하지 않습니다.

  • 코드 주석 스타일: 특정 문서화 형식이 필요합니다, 예를 들어 "모든 공용 메서드에 XML 문서 주석 포함" 또는 "인라인 주석에는 //을 사용하고 /* */는 사용하지 마세요."

  • 아키텍처 패턴: "모든 데이터 액세스 클래스는 인터페이스를 구현 IRepository<T> 해야 함" 또는 "모든 서비스 종속성에 종속성 주입 사용"과 같은 결정을 포함합니다.

  • 보안 및 규정 준수: "항상 데이터베이스 액세스에 매개 변수가 있는 쿼리 사용" 또는 "API 경계에서 모든 사용자 입력 유효성 검사"와 같은 규칙을 포함합니다.

경로별 지침은 더 많은 대상 지침을 허용합니다. 프런트 엔드와 백 엔드 코드, 테스트 파일과 프로덕션 코드 또는 고유한 요구 사항이 있는 특정 모듈에 다른 규칙이 적용될 수 있습니다. 이 세분성은 제안이 개발자가 작업 중인 코드베이스의 특정 영역과 관련이 있는지 확인합니다.

효과적인 지침을 작성하기 위한 팁

잘 만들어진 지침은 훨씬 더 나은 결과를 생성합니다. 다음은 사용자 지정 명령 파일을 최대한 활용하기 위한 팁입니다.

  • 규칙의 추론을 설명합니다. "단순히 '접두어로 프라이빗 필드를 _으로 사용합니다' 대신, '매개변수와 지역 변수를 한눈에 구분하기 위해 프라이빗 필드에 _ 접두어를 붙입니다'라고 작성하십시오. GitHub Copilot이 규칙의 존재 이유를 이해하면, 그 규칙이 더 일관되게 적용되며, 유사한 상황에도 원칙을 확장할 수 있습니다."

  • 간단한 코드 예제를 포함합니다. 예상된 패턴을 보여 주는 간단한 코드 조각과 지침을 페어링합니다. 예를 들어, "복잡한 객체 생성에 팩토리 패턴을 사용하십시오"라는 지시를 두 줄로 예시를 들어 설명하세요. 구체적인 예는 모호성을 줄입니다.

  • 명확하지 않은 규칙에 집중합니다. Linter 및 포맷터가 이미 적용하는 내용을 반복하지 마세요. 대신 팀만 알고 있는 규칙(예: 선호하는 라이브러리, 오류 처리를 위해 따라야 하는 패턴 또는 모듈 간에 존재하는 아키텍처 경계)을 문서화합니다.

  • 지침을 간결하고 구체적으로 유지합니다. 지나치게 길거나 모호한 명령 파일은 GitHub Copilot의 주의를 희석합니다. 각 명령은 하나의 명확한 규칙을 표현해야 합니다. 서로 겹치거나 모순되는 명령을 제거합니다.

  • 경로별 파일을 사용하여 문제를 구분합니다. 패턴이 있는 .instructions.md 파일을 사용하여 백 엔드 및 프런트 엔드 규칙을 분리하고, 프로덕션 코드와 별개의 테스트 논리를 유지하고, 애플리케이션 코드에서 격리된 인프라 스크립트를 사용합니다applyTo.

프롬프트 파일

Visual Studio Code는 항상 사용 가능한 컨텍스트를 제공하는 명령 파일 외에도 GitHub Copilot 채팅에서 슬래시 명령으로 호출할 수 있는 파일로 저장된 재사용 가능한 프롬프트 템플릿인 .prompt.md 지원합니다.

명령 파일은 GitHub Copilot가 응답하는 방식을 형성하지만 프롬프트 파일은 요청할 항목을 정의합니다. 프롬프트 파일에는 필요에 따라 실행하여 공통 작업을 일관되게 실행할 수 있는 선택적 변수 자리 표시자가 포함된 미리 작성된 프롬프트가 포함되어 있습니다. 예를 들어 코드 검토 검사 목록을 생성하거나, 현재 파일에 대한 단위 테스트를 만들거나, 특정 형식의 API 설명서를 생성하는 프롬프트 파일을 만들 수 있습니다.

프롬프트 파일의 작동 방식

프롬프트 파일은 .prompt.md 확장을 사용하며 작업 영역의 폴더(버전 제어를 통해 팀과 공유) 또는 Visual Studio Code 사용자 프로필(개인, 모든 작업 영역에서 사용 가능)에 저장할 .github/prompts/ 수 있습니다. 각 파일에는 선택적 YAML 프런트매터 헤더와 프롬프트 텍스트가 있는 Markdown 본문이 포함됩니다.

다음 예제에서는 단위 테스트를 생성하는 프롬프트 파일을 보여 줍니다.

---
description: 'Generate unit tests for the current file'
agent: 'copilot'
tools: ['search', 'read']
---
# Generate Unit Tests

Analyze the code in the active file and generate comprehensive unit tests.

For each public method or function:
1. Write a test for the expected behavior (happy path).
2. Write tests for edge cases and error conditions.
3. Use the project's existing test framework and naming conventions.

Output the tests as a complete, runnable test file.

프롬프트 파일에 대한 YAML 프런트매터는 다음 필드를 지원합니다.

분야 Description
description 프롬프트가 수행하는 작업을 자연어로 설명합니다. 슬래시 명령 선택기에서 나타납니다.
name 선택적 표시 이름입니다. 생략하면 파일 이름이 사용됩니다.
agent 프롬프트를 처리해야 하는 에이전트(예: copilot)입니다.
model 이 프롬프트에 대한 선택적 모델 기본 설정입니다.
tools 프롬프트가 실행될 때 액세스할 수 있는 도구입니다.

프롬프트 파일 사용

만든 프롬프트 파일은 GitHub Copilot 채팅 입력에 슬래시 명령으로 표시됩니다. / 입력 후 프롬프트 파일 이름(확장명 없이) .prompt.md을 선택하고 실행합니다. 예를 들어 이름이 지정된 generate-tests.prompt.md 파일이 명령이 /generate-tests 됩니다.

프롬프트 파일은 ${variable} 문법을 사용하여 변수 자리 표시자를 지원합니다. 변수 ${file} 는 현재 활성 파일을 참조하고 ${selection} 현재 텍스트 선택을 참조합니다. 프롬프트 파일이 실행될 때 사용자에게 입력을 요청하는 사용자 지정 변수를 정의할 수도 있습니다.

비고

프롬프트 파일을 사용하도록 설정하려면 Visual Studio Code에서 chat.promptFiles 설정이 켜져 있는지 확인하십시오. 활성화되면 .prompt.md 파일이 자동으로 검색되어 사용 가능한 슬래시 명령으로 등록됩니다.

제한점

사용자 지정 명령 파일에는 유의해야 할 몇 가지 중요한 제한 사항이 있습니다.

  • 인라인 자동 완성에는 영향을 주지 않습니다. 사용자 지정 지침은 GitHub Copilot 채팅 및 기타 상위 수준 요청에 적용됩니다. 편집기에서 입력할 때 표시되는 기본 인라인 코드 완성에는 영향을 주지 않습니다.

  • 간결성 문제: 크고 초점을 맞추지 않은 명령 파일은 희석되거나 예측할 수 없는 결과를 초래할 수 있습니다. 지침은 간결하고 가장 중요한 가이드라인과 관련 있어야 합니다. 린터나 포매터에 의해 이미 적용되지 않은 규칙에 집중하십시오.

  • 보장된 규정 준수 없음: 지침은 GitHub Copilot의 동작을 안내하지만 엄격한 규칙을 적용하지는 않습니다. AI는 다른 컨텍스트와 함께 지침을 고려하므로 결과가 예상과 다를 수 있습니다.

요약

사용자 지정 명령 파일 및 프롬프트 파일은 리포지토리, 경로 및 조직 수준에서 GitHub Copilot의 동작을 안내하는 구조화된 방법을 제공합니다. 프로젝트 전체 표준을 위한 .github/copilot-instructions.md 파일, 경로별 규칙에 대한 선택적 .instructions.md 파일, 그리고 재사용 가능한 프롬프트 템플릿을 위한 .prompt.md 파일을 생성하면 AI가 생성한 제안을 팀의 코딩 규칙에 일치시킬 수 있습니다. 추론, 예제 및 포커스가 있는 범위와 함께 효과적인 지침을 작성하면 이러한 사용자 지정 기능의 가치를 최대화합니다. 이러한 도구는 함께 수동 수정을 줄이고 코드 일관성을 개선하며 팀의 지식을 개발 워크플로에 직접 포함시킵니다.