Adicionando instruções personalizadas do repositório para GitHub Copilot

Esta versão deste artigo destina-se ao uso de instruções personalizadas do repositório no GitHub site. Clique nas guias acima para obter informações sobre como usar instruções personalizadas em outros ambientes.

Introdução

As instruções personalizadas de repositório permitem fornecer orientações e preferências específicas do repositório ao Copilot. Para saber mais, confira Sobre a personalização das respostas do GitHub Copilot.

Pré-requisitos para instruções personalizadas de repositório

• Você deve ter um arquivo de instruções personalizado (confira as instruções abaixo).

• Para Revisão de código com Copilot, sua escolha pessoal de usar instruções personalizadas deve estar definida como habilitada. Isso é habilitado por padrão. Confira Habilitando ou desabilitando instruções personalizadas de repositório mais adiante neste artigo.

Como criar instruções personalizadas

          Copilot no GitHub suporta os três tipos de instruções personalizadas do repositório. Para obter detalhes sobre quais GitHub Copilot recursos dão suporte a esses tipos de instruções, consulte [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#support-for-repository-custom-instructions).

* Instruções personalizadas em todo o repositório se aplicam a todas as solicitações feitas no contexto de um repositório.

Elas são especificados em um arquivo copilot-instructions.md no diretório .github do repositório. Consulte Como criar instruções personalizadas em todo o repositório.

•         **Instruções personalizadas específicas do caminho** se aplicam a solicitações feitas no contexto de arquivos que correspondem a um caminho especificado.
  

  Eles são especificados em um ou mais NAME.instructions.md arquivos dentro ou abaixo do .github/instructions diretório no repositório. Consulte Como criar instruções personalizadas específicas do caminho.

  Se o caminho especificado corresponder a um arquivo no qual Copilot está trabalhando e também existir um arquivo de instruções personalizadas no repositório, as instruções de ambos os arquivos serão usadas.

•         **Instruções do agente** são usadas por agentes de IA.
  

  Você pode criar um ou mais arquivos AGENTS.md armazenados em qualquer lugar no repositório. Quando Copilot estiver funcionando, o arquivo mais próximo AGENTS.md na árvore de diretório terá precedência. Para obter mais informações, consulte o repositório agentsmd/agents.md.

  Como alternativa, você pode usar um único arquivo CLAUDE.md ou GEMINI.md armazenado na raiz do repositório.

Como criar instruções personalizadas em todo o repositório

Você pode criar seu próprio arquivo de instruções personalizadas do zero. Consulte Como escrever seu próprio arquivo copilot-instructions.md. Como alternativa, você pode pedir agente de codificação Copilot para gerar um para você.

Solicitando agente de codificação Copilot para gerar um copilot-instructions.md arquivo

1. Navegue até a guia agentes em github.com/copilot/agents.

   Você também pode acessar esta página clicando no botão ao lado da barra de pesquisa em qualquer página GitHube selecionando Agentes na barra lateral.

2. Usando o menu suspenso no campo de solicitação, selecione o repositório para o qual você deseja Copilot gerar instruções personalizadas.

3. Copie o prompt a seguir e cole-o no campo de prompt, personalizando-o, se necessário:

   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 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 or press Enter.

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. Crie o diretório .github/instructions se ele ainda não existir.

2. Opcionalmente, crie subdiretórios de .github/instructions para organizar seus arquivos de instrução.

3. Crie um ou mais arquivos NAME.instructions.md, em que NAME indica a finalidade das instruções. O nome do arquivo deve terminar com .instructions.md.

4. No início do arquivo, crie um bloco frontmatter contendo a palavra-chave applyTo. Use a sintaxe glob para especificar a quais arquivos ou diretórios as instruções se aplicam.

   Por exemplo:

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

   Você pode especificar vários padrões separando-os com vírgulas. Por exemplo, para aplicar as instruções a todos os arquivos TypeScript no repositório, você pode usar o seguinte bloco frontmatter:

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

   Exemplos do Glob:

   •      `*` – corresponderá a todos os arquivos no diretório atual.
     

   •      `**` ou `**/*` – todos corresponderão a todos os arquivos em todos os diretórios.
     

   •      `*.py` – corresponderá a todos os `.py` arquivos no diretório atual.
     

   •      `**/*.py` – corresponderá recursivamente a todos os `.py` arquivos em todos os diretórios.
     

   •      `src/*.py` – corresponderá a todos os `.py` arquivos no `src` diretório. Por exemplo, `src/foo.py` mas `src/bar.py`_não_`src/foo/bar.py`.
     

   •      `src/**/*.py` – corresponderá recursivamente a todos os `.py` arquivos no `src` diretório. Por exemplo, `src/foo.py`, `src/foo/bar.py` e `src/foo/bar/baz.py`.
     

   •      `**/subdir/**/*.py` – fará a correspondência recursiva de todos os arquivos `.py` em qualquer diretório `subdir` em qualquer profundidade. Por exemplo, `subdir/foo.py`, `subdir/nested/bar.py`, `parent/subdir/baz.py`e `deep/parent/subdir/nested/qux.py`, mas _não_`foo.py` em um caminho que não contém um `subdir` diretório.
     

5. Opcionalmente, para impedir que o arquivo seja usado por agente de codificação Copilot ou Revisão de código com Copilot, adicione a palavra-chave excludeAgent ao bloco de frontmatter. Use "code-review" ou "coding-agent".

   Por exemplo, o arquivo a seguir será lido apenas por agente de codificação Copilot.

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

   Se a excludeAgent palavra-chave não estiver incluída no bloco de matéria frontal, ambos Revisão de código com Copilot e agente de codificação Copilot usarão suas instruções.

6. Adicione suas instruções personalizadas em linguagem natural usando o formato Markdown. O espaço em branco entre as instruções é ignorado, de modo que as instruções podem ser escritas como um só parágrafo, cada uma em uma nova linha ou separadas por linhas em branco para facilitar a leitura.

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Sim</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>Não</span></a>

Instruções personalizadas em uso

As instruções nos arquivos estarão disponíveis para uso por Copilot assim que você salvar os arquivos. As instruções são adicionadas automaticamente às solicitações que você envia para Copilot.

In Chat Copilot (github.com/copilot), you can start a conversation that uses repository custom instructions by adding, as an attachment, the repository that contains the instructions file.

Whenever repository custom instructions are used by Chat Copilot, the instructions file is added as a reference for the response that's generated. To find out whether repository custom instructions were used, expand the list of references at the top of a chat response in the Chat panel and check whether the .github/copilot-instructions.md file is listed.

You can click the reference to open the file.

Enabling or disabling custom instructions for Revisão de código com Copilot

Custom instructions are enabled for Revisão de código com Copilot by default but you can disable, or re-enable, them in the repository settings on GitHub.com. This applies to Copilot's use of custom instructions for all code reviews it performs in this repository.

1. Em GitHub, acesse a página principal do repositório.

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. In the "Code & automation" section of the sidebar, click Copilot, then Code review.

4. Toggle the “Use custom instructions when reviewing pull requests” option on or off.

Further reading

• Suporte para diferentes tipos de instruções personalizadas
• Instruções personalizadas—a curated collection of examples
• Usando instruções personalizadas para desbloquear o poder da revisão de código Copilot