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

이 문서의 버전은 GitHub 웹 사이트의 리포지토리 사용자 지정 지침에 대한 것입니다. 다른 환경에서 사용자 지정 지침을 사용하는 방법에 대한 자세한 내용은 위의 탭을 클릭합니다.

리포지토리 사용자 지정 지침은 현재 다음을 지원합니다.

• VS Code에서 Copilot Chat
• Copilot 코딩 에이전트
• Visual Studio, JetBrains IDE, Xcode, 및 GitHub 웹사이트(copilot-instructions.md 파일만 해당)에서 Copilot Chat
• Copilot 코드 검토(copilot-instructions.md 파일만 해당)
• Copilot 코드 검토

Prerequisites for repository custom instructions

• You must have a custom instructions file (see the instructions below).

• 사용자 지정 지침을 사용할지 여부를 개인적으로 선택할 수 있도록 설정해야 합니다. 이 옵션은 기본적으로 사용하도록 설정되어 있습니다. 이 문서의 뒷부분에 있는 리포지토리 사용자 지정 지침 사용 또는 사용 안 함을 참조하세요.

GitHub.com에서 사용하기 위한 여러 유형의 리포지토리 사용자 지정 지침을 만들 수 있습니다.

• 리포지토리 전체 사용자 지정 지침은 리포지토리의 컨텍스트에서 수행한 모든 요청에 적용됩니다.

  지원: Copilot Chat, Copilot 코딩 에이전트, Copilot 코드 검토.

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

• 경로별 사용자 지정 지침은 지정된 경로와 일치하는 파일 컨텍스트에서 수행한 요청에 적용됩니다.

  지원: Copilot 코딩 에이전트 및 Copilot 코드 검토.

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

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

• 에이전트 지침은 AI 에이전트에서 사용됩니다.

  지원: Copilot 코딩 에이전트.

  리포지토리 내의 어느 곳에나 저장된 하나 이상의 AGENTS.md 파일을 만들 수 있습니다. Copilot이 작동하는 경우, 디렉터리 트리에서 가장 가까운 AGENTS.md 파일이 우선적으로 적용됩니다.

  또는 리포지토리의 루트에 저장된 단일 CLAUDE.md 또는 GEMINI.md 파일을 사용할 수 있습니다.

리포지토리 전체 사용자 지정 지침 만들기

사용자 지정 지침 파일을 처음부터 만들 수 있습니다. 사용자 고유의 copilot-instructions.md 파일 작성을 참조하세요. 또는 Copilot 코딩 에이전트에 요청하여 생성하도록 요청할 수 있습니다.

Copilot 코딩 에이전트에 copilot-instructions.md 파일을 생성하도록 요청합니다.

1. Agents 페이지(github.com/copilot/agents)로 이동합니다.

   GitHub에 대한 모든 페이지의 검색 창 옆에 있는 단추를 클릭한 다음, 사이드바에서 Agents를 선택하여 이 페이지로 이동할 수도 있습니다.

2. 프롬프트 필드의 드롭다운 메뉴를 사용하여 Copilot에서 사용자 지정 지침을 생성할 리포지토리를 선택합니다.

3. 다음 프롬프트를 복사하여 필요한 경우 사용자 지정합니다.

   Markdown

   Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.
   
   You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.
   
   <Goals>
   - Reduce the likelihood of a coding agent pull request getting rejected by the user due to
   generating code that fails the continuous integration build, fails a validation pipeline, or
   having misbehavior.
   - Minimize bash command and build failures.
   - Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools.
   </Goals>
   
   <Limitations>
   - Instructions must be no longer than 2 pages.
   - Instructions must not be task specific.
   </Limitations>
   
   <WhatToAdd>
   
   Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time:
   <HighLevelDetails>
   
   - A summary of what the repository does.
   - High level repository information, such as the size of the repo, the type of the project, the languages, frameworks, or target runtimes in use.
   </HighLevelDetails>
   
   Add information about how to build and validate changes so the agent does not need to search and find it each time.
   <BuildInstructions>
   
   - For each of bootstrap, build, test, run, lint, and any other scripted step, document the sequence of steps to take to run it successfully as well as the versions of any runtime or build tools used.
   - Each command should be validated by running it to ensure that it works correctly as well as any preconditions and postconditions.
   - Try cleaning the repo and environment and running commands in different orders and document errors and and misbehavior observed as well as any steps used to mitigate the problem.
   - Run the tests and document the order of steps required to run the tests.
   - Make a change to the codebase. Document any unexpected build issues as well as the workarounds.
   - Document environment setup steps that seem optional but that you have validated are actually required.
   - Document the time required for commands that failed due to timing out.
   - When you find a sequence of commands that work for a particular purpose, document them in detail.
   - Use language to indicate when something should always be done. For example: "always run npm install before building".
   - Record any validation steps from documentation.
   </BuildInstructions>
   
   List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching.
   <ProjectLayout>
   
   - A description of the major architectural elements of the project, including the relative paths to the main project files, the location
   of configuration files for linting, compilation, testing, and preferences.
   - A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines.
   - Document the steps so that the agent can replicate these itself.
   - Any explicit validation steps that the agent can consider to have further confidence in its changes.
   - Dependencies that aren't obvious from the layout or file structure.
   - Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the
   contents of the README, the contents of any key source files, the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files, such as the one containing the main method.
   </ProjectLayout>
   </WhatToAdd>
   
   <StepsToFollow>
   - Perform a comprehensive inventory of the codebase. Search for and view:
   - README.md, CONTRIBUTING.md, and all other documentation files.
   - Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc.
   - All scripts, particularly those pertaining to build and repo or environment setup.
   - All build and actions pipelines.
   - All project files.
   - All configuration and linting files.
   - For each file:
   - think: are the contents or the existence of the file information that the coding agent will need to implement, build, test, validate, or demo a code change?
   - If yes:
      - Document the command or information in detail.
      - Explicitly indicate which commands work and which do not and the order in which commands should be run.
      - Document any errors encountered as well as the steps taken to workaround them.
   - Document any other steps or information that the agent can use to reduce time spent exploring or trying and failing to run bash commands.
   - Finally, explicitly instruct the agent to trust the instructions and only perform a search if the information in the instructions is incomplete or found to be in error.
   </StepsToFollow>
      - Document any errors encountered as well as the steps taken to work-around them.
   
   

4. Click Send now or press Return.

Copilot will start a new session, which will appear in the list below the prompt box. Copilot will create a draft pull request, write your custom instructions, push them to the branch, then add you as a reviewer when it has finished, triggering a notification.

Writing your own copilot-instructions.md file

1. In the root of your repository, create a file named .github/copilot-instructions.md.

   Create the .github directory if it does not already exist.

2. Add natural language instructions to the file, in Markdown format.

   Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.

Creating path-specific custom instructions

1. Create the .github/instructions directory if it does not already exist.

2. Create one or more NAME.instructions.md files, where NAME indicates the purpose of the instructions. The file name must end with .instructions.md.

3. At the start of the file, create a frontmatter block containing the applyTo keyword. Use glob syntax to specify what files or directories the instructions apply to.

   For example:

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

   You can specify multiple patterns by separating them with commas. For example, to apply the instructions to all TypeScript files in the repository, you could use the following frontmatter block:

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

   To apply the instructions to all files, use applyTo: "**".

4. Add your custom instructions in natural language, using Markdown format. Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.

Copilot Chat의 몰입형 보기(github.com/copilot)에서 지침 파일이 포함된 리포지토리를 첨부 파일로 추가하여 리포지토리 사용자 지정 지침을 사용하는 대화를 시작할 수 있습니다.

리포지토리 사용자 지정 지침이 Copilot Chat에서 사용될 때마다 지침 파일은 생성된 응답에 대한 참조로 추가됩니다. 리포지토리 사용자 지정 지침이 사용되었는지 확인하려면 채팅 패널에서 채팅 응답 맨 위에 있는 참조 목록을 확장하고 .github/copilot-instructions.md 파일이 나열되어 있는지 확인합니다.

참조를 클릭하여 파일을 열 수 있습니다.

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

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

Copilot Chat에 대한 사용자 지정 지침 사용 또는 사용 안 함

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

1. GitHub.com에서 다음 중 하나를 수행합니다.

   • 사용자 지정 지침 파일이 있는 리포지토리로 이동한 후 보조 채팅 패널을 엽니다.
   • Copilot Chat(github.com/copilot)의 몰입형 보기로 이동한 후 사용자 지정 지침 파일이 포함된 리포지토리를 연결합니다.

2. 채팅 패널의 위쪽 또는 몰입형 페이지의 오른쪽 위에 있는 단추를 클릭합니다.

3. Disable custom instructions 또는 Enable custom instructions를 클릭합니다.

   참고 항목

   사용자 지정 지침 파일이 포함된 리포지토리의 컨텍스트에서만 이러한 옵션이 표시됩니다.

선택한 옵션은 사용자가 변경할 때까지 사용자 지정 지침 파일이 포함된 모든 리포지토리에 계속 적용됩니다.

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

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

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

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

   

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

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