Adding repository custom instructions for GitHub Copilot in your IDE

This version of this article is for using repository custom instructions and prompt files in Visual Studio. Click the tabs above for instructions on using custom instructions in other environments.

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).

• The Enable custom instructions... option must be enabled in your settings. This is enabled by default. See Enabling or disabling repository custom instructions later in this article.

Creating custom instructions

Visual Studio supports two types of custom instructions. For details of which GitHub Copilot features support these types of instructions, see Sobre a personalização das respostas do GitHub Copilot.

• Repository-wide custom instructions, which apply to all requests made in the context of a repository.

  These are specified in a copilot-instructions.md file in the .github directory of the repository. See Creating repository-wide custom instructions.

• Path-specific custom instructions, which apply to requests made in the context of files that match a specified path.

  These are specified in one or more NAME.instructions.md files within or below the .github/instructions directory in the repository. See Creating path-specific custom instructions.

  If the path you specify matches a file that Copilot is working on, and a repository-wide custom instructions file also exists, then the instructions from both files are used.

Creating repository-wide custom instructions

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.pynãosrc/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.pye deep/parent/subdir/nested/qux.py, mas nãofoo.py em um caminho que não contém um subdir diretório.

5. Opcionalmente, para impedir que o arquivo seja usado por Copilot cloud agent ou Copilot code review, adicione a palavra-chave excludeAgent ao bloco de frontmatter. Use "code-review" ou "cloud-agent".

   Por exemplo, o arquivo a seguir será lido apenas por Copilot cloud agent.

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

   Se a palavra-chave excludeAgent não estiver incluída no bloco front-matter, tanto o Copilot code review quanto o Copilot cloud agent 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.

Instruções personalizadas em uso

As instruções no(s) arquivo(s) estarão disponíveis para uso por Copilot quando você salvar o(s) arquivo(s). As instruções são adicionadas automaticamente às solicitações que você envia para Copilot.

As instruções personalizadas não ficam visíveis na exibição do Chat ou no chat embutido, mas você pode verificar se elas estão sendo usadas pelo Copilot observando a lista Referências de uma resposta na exibição do Chat. Se foram adicionadas instruções personalizadas à solicitação que foi enviada para o modelo, o arquivo .github/copilot-instructions.md será listado como uma referência. Selecione a referência para abrir o arquivo.

Habilitando ou desabilitando instruções personalizadas de repositório

Você pode escolher se quer ou não que o Copilot use instruções personalizadas baseadas em repositório.

Habilitar ou desabilitar instruções personalizadas para o Copilot Chat

As instruções personalizadas são habilitadas para o Copilot Chat por padrão, mas você pode desabilitá-las ou reabilitá-las a qualquer momento. Isso se aplica ao seu próprio uso do Copilot Chat e não afeta outros usuários.

1. In the Visual Studio menu bar, under Tools, click Options.

   

2. In the "Options" dialog, type custom instructions in the search box, then click Copilot.

3. Select or clear the checkbox for Enable custom instructions to be loaded from .github/copilot-instructions.md files and added to requests.

   

Habilitar ou desabilitar instruções personalizadas para Copilot code review

As instruções personalizadas são ativadas por padrão para Copilot code review, mas você pode desativá-las ou reativá-las nas configurações do repositório em GitHub.com. Isso se aplica ao Copilotuso de instruções personalizadas para todas as revisões de código executadas neste repositório.

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. Na barra lateral, em "Código, planejamento e automação", clique Copilot e, em seguida, revisão de código.

4. Ative ou desative a opção "Usar instruções personalizadas ao revisar pull requests".

Using prompt files

Prompt files let you build and share reusable prompt instructions with additional context. A prompt file is a Markdown file, stored in your workspace, that mimics the existing format of writing prompts in Copilot Chat (for example, Rewrite #file:x.ts). You can have multiple prompt files in your workspace, each of which defines a prompt for a different purpose.

Creating prompt files

1. Add a prompt file, including the .prompt.md file name extension inside the .github/prompts folder in the root of the repository. The name can contain alphanumeric characters and spaces and should describe the purpose of the prompt information the file will contain.

2. Write the prompt instructions, using Markdown formatting.

   You can reference other files in the workspace by using Markdown links—for example, [index](../../web/index.ts)—or by using the #file:'../../web/index.ts' syntax. Paths are relative to the prompt file. Referencing other files allows you to provide additional context, such as API specifications or product documentation.

For more information about prompt files, see Use prompt files in Visual Studio in the Visual Studio documentation.

Further reading

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