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

또한 프롬프트 파일을 만들 수 있습니다. 프롬프트 파일을 사용하면 Markdown 파일(*.prompt.md)에서 일반적인 프롬프트 지침과 관련 컨텍스트를 지정한 다음, 채팅 프롬프트에서 다시 사용할 수 있습니다. 프롬프트 파일은 VS Code에서만 사용할 수 있습니다.

• 설정에서 Use Instruction Files 옵션을 활성화해야 합니다. 이 옵션은 기본적으로 사용하도록 설정되어 있습니다. 이 문서의 뒷부분에 있는 리포지토리 사용자 지정 지침 사용 또는 사용 안 함을 참조하세요.

.github/copilot-instructions.md 파일의 지침은 파일을 저장하는 즉시 Copilot Chat에서 사용할 수 있습니다. 전체 지침 집합은 Copilot Chat 보기 또는 인라인 채팅에서 제출하는 요청에 자동으로 첨부됩니다.

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

1. 바로 가기 키 Command+,(Mac) / Ctrl+,(Linux/Windows)을 사용하여 설정 편집기를 엽니다.
2. 검색 상자에 instruction file를 입력합니다.
3. Code Generation: Use Instruction Files 아래 확인란을 선택하거나 선택 취소합니다.

프롬프트 파일 정보

프롬프트 파일을 사용하면 추가 컨텍스트와 함께 재사용 가능한 프롬프트 지침을 작성하고 공유할 수 있습니다. 프롬프트 파일은 Copilot Chat의 기존 쓰기 프롬프트 형식과 유사한 Markdown 파일입니다(예 Rewrite #file:x.ts). 이렇게 하면 자연어 명령, 추가 컨텍스트를 혼합하고 다른 프롬프트 파일에 종속성으로 연결할 수도 있습니다.

사용자 지정 지침은 각 AI 워크플로에 코드베이스 전체 컨텍스트를 추가하는 데 도움이 되지만 프롬프트 파일을 사용하면 특정 채팅 상호 작용에 지침을 추가할 수 있습니다.

일반 사용 사례는 다음과 같습니다.

• 코드 생성. 구성 요소, 테스트 또는 마이그레이션(예: React 양식 또는 API 모의)에 대해 재사용 가능한 프롬프트를 만듭니다.
• 도메인 전문 지식. 보안 사례 또는 규정 준수 검사 등 프롬프트를 통해 전문 지식을 공유합니다.
• 팀 공동 작업. 사양 및 문서를 참조하여 패턴과 지침을 문서화합니다.
• 온보딩. 복잡한 프로세스 또는 프로젝트별 패턴에 대한 단계별 가이드를 만듭니다.

프롬프트 파일 예제

다음 예제에서는 프롬프트 파일을 사용하는 방법을 보여 줍니다.

• react-form.prompt.md - 양식을 생성하기 위한 재사용 가능한 작업을 문서화합니다.

  Your goal is to generate a new React form component.
  
  Ask for the form name and fields if not provided.
  
  Requirements for the form:
  - Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
  - Use `react-hook-form` for form state management:
    - Always define TypeScript types for your form data
    - Prefer *uncontrolled* components using register
    - Use `defaultValues` to prevent unnecessary rerenders
  - Use `yup` for validation:
    - Create reusable validation schemas in separate files
    - Use TypeScript types to ensure type safety
    - Customize UX-friendly validation rules
  

• security-api.prompt.md - REST API의 보안 검토를 수행하는 데 사용할 수 있는 REST API에 대해 재사용 가능한 보안 사례를 문서화합니다.

  Secure REST API review:
  - Ensure all endpoints are protected by authentication and authorization
  - Validate all user inputs and sanitize data
  - Implement rate limiting and throttling
  - Implement logging and monitoring for security events
  …
  

프롬프트 파일 사용

프롬프트 파일을 사용하도록 설정하려면 chat.promptFiles VS Code 설정을 구성합니다. 이를 true로 설정하거나 { "/path/to/folder": boolean } 표기법을 설정하거나 표기법을 사용하여 다른 경로를 지정합니다. 상대 경로는 작업 영역의 루트 폴더에서 확인되며 다른 경로가 제공되지 않은 경우 기본값인 .github/prompts가 사용됩니다. 보다 자세한 지침은 Visual Studio Code 설명서의 VS Code 설정 참조에서 GitHub Copilot 설정을 참조하세요.

1. 작업 영역의 .github/prompts 디렉터리에 .prompt.md 파일을 만듭니다.

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

   추가 작업 영역 파일을 Markdown 링크([index](../index.ts)) 또는 프롬프트 파일 내의 #file:../index.ts 참조로 참조합니다. 다른 .prompt.md 파일을 참조할 수도 있습니다.

3. 연결 아이콘을 선택한 다음, Prompt... 를 선택하고 Copilot Chat 또는 Copilot Edits에서 첨부할 프롬프트 파일을 선택합니다.

4. 필요에 따라 작업에 필요한 추가 컨텍스트 파일을 첨부합니다.

5. 채팅 프롬프트를 보냅니다.

   • 재사용 가능한 작업의 경우 추가 지침 없이 프롬프트를 보냅니다.
   • 현재 작업에 대한 더 많은 컨텍스트를 제공하기 위한 추가 지침을 포함합니다.