IDE에서 GitHub Copilot에 대한 리포지토리 사용자 지정 지침 추가

이 문서의 이 버전은 .에서 Visual Studio리포지토리 사용자 지정 지침 및 프롬프트 파일을 사용하기 위한 것입니다. 기타 환경에서 사용자 지정 지침의 사용법은 위의 탭을 클릭하세요.

소개

리포지토리 사용자 지정 지침을 사용하면 Copilot에 리포지토리별 지침 및 기본 설정을 제공할 수 있습니다. 자세한 내용은 GitHub Copilot 응답을 사용자 지정하는 방법에 대한 정보을(를) 참조하세요.

리포지토리 사용자 지정 지침의 필수 조건

• 사용자 지정 지침 파일이 있어야 합니다(아래 지침 참조).

• 설정에서 Enable custom instructions... 옵션을 반드시 활성화해야 합니다. 이 옵션은 기본적으로 사용하도록 설정되어 있습니다. 이 문서의 뒷부분에 있는 리포지토리 사용자 지정 지침 활성화 또는 비활성화를 참조하세요.

사용자 지정 지침 생성하기

          Visual Studio 는 두 가지 유형의 사용자 지정 명령을 지원합니다. 이러한 유형의 지침을 지원하는 기능에 대한 자세한 내용은 GitHub Copilot[AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=visualstudio#support-for-repository-custom-instructions-2)을 참조하세요.

• 리포지토리 전체 사용자 지정 지침은 리포지토리 컨텍스트에서 만들어진 모든 요청에 ​​적용됩니다.

  이는 리포지토리의 copilot-instructions.md 디렉터리에 있는 .github 파일에 지정됩니다. 리포지토리 전체 사용자 지정 지침 생성하기를 참조하세요.

• 경로별 사용자 지정 지침은 지정된 경로와 일치하는 파일의 컨텍스트에서 이루어진 요청에 적용됩니다.

  이러한 파일은 리포지토리의 NAME.instructions.md 디렉터리 내 또는 아래에 있는 하나 이상의 .github/instructions 파일에 지정됩니다. 경로별 사용자 지정 지침 생성하기를 참조하세요.

  지정한 경로가 Copilot 작업 중인 파일과 일치하고 리포지토리 전체의 사용자 지정 지침 파일도 있는 경우 두 파일의 지침이 모두 사용됩니다.

리포지토리 전체 사용자 지정 지침 생성하기

1. 리포지토리의 루트에서 .github/copilot-instructions.md 파일을 만듭니다.

   아직 없는 경우 .github 디렉터리를 만듭니다.

2. 파일에 자연어 지침을 Markdown 형식으로 추가하세요

   지침 사이의 공백은 무시되므로 지침을 새 줄에 각각 단일 단락으로 작성하거나 가독성을 위해 빈 줄로 구분할 수 있습니다.

경로별 사용자 지정 지침 만들기

1.        `.github/instructions` 디렉터리가 아직 없는 경우, 새로 만듭니다.
   

2. 필요에 따라 .github/instructions의 하위 디렉터리를 만들어 명령 파일을 체계적으로 정리할 수 있습니다.

3. 하나 이상의 NAME.instructions.md 파일을 만드세요. 여기서 NAME은 지침의 목적을 나타냅니다. 파일 이름은 .instructions.md로 끝나야 합니다.

4. 파일의 시작 부분에, applyTo 키워드를 포함하는 프론트매터 블록을 만드세요. glob 구문을 사용하여 지침이 적용될 파일이나 디렉터리를 지정합니다.

   예시:

   ---
   applyTo: "app/models/**/*.rb"
   ---
   

   쉼표로 여러 패턴을 구분하여 지정할 수 있습니다. 예를 들어, 리포지토리의 모든 TypeScript 파일에 지침을 적용하려면, 다음과 같은 프론트매터 블록을 사용할 수 있습니다.

   ---
   applyTo: "**/*.ts,**/*.tsx"
   ---
   

   Glob 예제:

   • * - 현재 디렉터리의 모든 파일과 일치합니다.
   • ** 또는 **/* - 모든 디렉터리에 있는 모든 파일과 일치합니다.
   • *.py - 현재 디렉터리의 모든 .py 파일과 일치합니다.
   • **/*.py - 모든 디렉터리에 있는 모든 .py 파일을 재귀적으로 일치합니다.
   • src/*.py - .py 디렉터리 내 모든 src 파일을 일치시킵니다. 예를 들어, src/foo.py 와 src/bar.py 그러나 아니src/foo/bar.py.
   • src/**/*.py - 디렉터리의 모든 .py 파일 src 과 재귀적으로 일치합니다. 예: src/foo.py, src/foo/bar.py및 src/foo/bar/baz.py.
   • **/subdir/**/*.py - 모든 .py 디렉터리의 깊은 곳에 있는 모든 subdir 파일을 재귀적으로 일치시킵니다. 예를 들어 subdir/foo.py, subdir/nested/bar.py, parent/subdir/baz.py, deep/parent/subdir/nested/qux.py와 같은 경우에는 사용되지만, 디렉터리foo.py가 포함되지 않은 subdir 경로에서는 사용되지 않습니다.

5. 파일이 Copilot 클라우드 에이전트 또는 Copilot 코드 검토에 의해 사용되는 것을 방지하려면, 프런트매터 블록의 앞부분에 excludeAgent 키워드를 추가하십시오. 또는 "code-review"``"cloud-agent".를 사용합니다.

   예를 들어 다음 파일은 Copilot 클라우드 에이전트에서만 읽힙니다.

   ---
   applyTo: "**"
   excludeAgent: "code-review"
   ---
   

   키워드가 excludeAgent 프론트 머터블록에 포함되지 않은 경우, Copilot 코드 검토와 Copilot 클라우드 에이전트는 둘 다 귀하의 지침을 사용합니다.

6. Markdown 형식을 사용하여 자연어로 사용자 지정 지침을 추가합니다. 지침 사이의 공백은 무시되므로 지침을 새 줄에 각각 단일 단락으로 작성하거나 가독성을 위해 빈 줄로 구분할 수 있습니다.

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>예</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>아니오</span></a>

사용 중인 사용자 지정 지침

파일의 지침은 파일을 저장하는 즉시 Copilot가 사용할 수 있습니다. 제출한 요청에 지침이 Copilot자동으로 추가됩니다.

사용자 지정 지침은 채팅 보기 또는 인라인 채팅에 표시되지 않지만 채팅 보기에서 응답의 참조 목록을 확인하여 Copilot에서 이 지침이 사용되고 있는지 여부를 확인할 수 있습니다. 사용자 지정 지침이 모델에 전송된 프롬프트에 추가된 경우 .github/copilot-instructions.md 파일이 참조로 나열됩니다. 참조를 클릭하여 파일을 열 수 있습니다.

리포지토리 사용자 지정 지침 사용 또는 사용 안 함

Copilot에서 리포지토리 기반 사용자 지정 지침을 사용할지 여부를 선택할 수 있습니다.

공동 파일럿 채팅에 대한 사용자 지정 지침 사용 또는 사용 안 함

사용자 지정 지침은 기본적으로 공동 파일럿 채팅를 사용하도록 설정되어 있지만 언제든지 사용하지 않도록 설정하거나 다시 사용하도록 설정할 수 있습니다. 이는 공동 파일럿 채팅를 사용하는 사용자 본인에게만 적용되며 다른 사용자에게는 영향을 주지 않습니다.

1. 메뉴 모음의 Visual Studio도구에서 옵션을 클릭합니다.

   

2. "옵션" 대화 상자에서 검색 상자를 입력 custom instructions 한 다음 을 클릭합니다 Copilot.

3.        **사용자 지정 지침을 .github/copilot-instructions.md 파일에서 로드하고 요청에 추가할 수 있도록 설정** 확인란을 선택하거나 선택 취소합니다.
   

   

Copilot 코드 검토의 사용자 지정 지침 사용 또는 사용 안 함

사용자 지정 지침은 기본적으로 Copilot 코드 검토를 사용하도록 설정되어 있지만 GitHub.com의 리포지토리 설정에서 사용하지 않도록 설정하거나 다시 사용하도록 설정할 수 있습니다. 이는 이 리포지토리에서 수행하는 모든 코드 검토에 대해 Copilot의 사용자 지정 지침 사용에 적용됩니다.

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

2. 리포지토리 이름 아래에서 Settings를 클릭합니다. "설정" 탭이 표시되지 않으면 드롭다운 메뉴를 선택한 다음 설정을 클릭합니다.

   

3. 사이드바의 "Code & automation" 섹션에서 Copilot 을 클릭한 다음, Code review를 클릭합니다.

4. “끌어오기 요청을 검토할 때 사용자 지정 지침 사용” 옵션을 켜거나 끕니다.

프롬프트 파일 사용

프롬프트 파일을 사용하면 추가 컨텍스트를 포함한 재사용 가능한 프롬프트 지침을 생성하고 공유할 수 있습니다. 프롬프트 파일은 작업 영역에 저장된 Markdown 파일로, 프롬프트의 기존 형식을 모방합니다 공동 파일럿 채팅 (예: Rewrite #file:x.ts). 작업 영역에 여러 프롬프트 파일을 포함할 수 있으며, 각 파일은 각각의 용도로 프롬프트를 정의합니다.

프롬프트 파일 만들기

1. 리포지토리의 루트에 .prompt.md 있는 폴더 내에 .github/prompts 파일 이름 확장명을 포함하여 프롬프트 파일을 추가합니다. 이름은 영숫자 문자와 공백을 포함할 수 있으며 파일에 포함할 프롬프트 정보의 용도를 설명해야 합니다.

2. Markdown 서식을 사용하여 프롬프트 지침을 작성합니다.

   Markdown 링크(예: [index](../../web/index.ts)) 또는 #file:'../../web/index.ts' 구문을 사용하여 작업 영역의 다른 파일을 참조할 수 있습니다. 경로는 프롬프트 파일을 기준으로 상대적입니다. 다른 파일을 참조하면 API 사양 또는 제품 설명서와 같은 추가 컨텍스트를 제공할 수 있습니다.

프롬프트 파일에 대한 자세한 내용은 설명서의 Visual StudioVisual Studio 참조하세요.

추가 읽기

• 다양한 유형의 사용자 지정 지침 지원
• 사용자 지정 라이브러리 - 큐레이팅된 예제 컬렉션
• 사용자 지정 지침을 사용하여 Copilot 코드 검토의 기능 잠금 해제