Adding repository custom instructions for GitHub Copilot

Create a file in a repository that gives Copilot additional context for the work it does in that repository.

Neste artigo

Observação

This feature is currently in versão prévia pública and is subject to change.

This version of this article is for using repository custom instructions on the GitHub website. Click the tabs above for information on using custom instructions in other environments.

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

Observação

This feature is currently in versão prévia pública and is subject to change.

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

Observação

This feature is currently in versão prévia pública and is subject to change.

This version of this article is for using repository custom instructions in JetBrains IDEs. Click the tabs above for instructions on using custom instructions in other environments.

Observação

This feature is currently in versão prévia pública and is subject to change.

This version of this article is for using repository custom instructions in Xcode. Click the tabs above for instructions on using custom instructions in other environments.

About repository custom instructions for Copilot

Repository custom instructions let you provide Copilot with repository-specific guidance and preferences.

Repository custom instructions are currently supported for:

  • Copilot Chat in VS Code
  • Agente de codificação do Copilot
  • Copilot Chat in Visual Studio, JetBrains IDEs, Xcode, and on the GitHub website (copilot-instructions.md file only)
  • Revisão de código do Copilot (copilot-instructions.md file only)

Prerequisites for repository custom instructions

  • You must have a custom instructions file (see the instructions below).
  • The latest version of the Copilot extension must be installed in your JetBrains IDE.
  • The latest version of the Copilot extension must be installed in Xcode.

Creating a repository custom instructions file

JetBrains IDEs support a single .github/copilot-instructions.md custom instructions file stored in the repository.

You can create a custom instructions file in your repository using the Copilot settings page, or you can create the file manually.

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.

Using the settings page

  1. No seu IDE JetBrains, clique no menu Arquivo (Windows) ou no nome do aplicativo na barra de menus (macOS) e clique em Configurações.
  2. Em Linguagens e Estruturas, clique em GitHub Copilot .
  3. Under "Copilot Instructions", click Workspace or Global to choose whether the custom instructions apply to the current workspace or all workspaces.

Manually creating a workspace custom instructions 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.

Once saved, these instructions will apply to the current workspace in JetBrains IDEs that you open with Copilot enabled.

Manually creating a global custom instructions file

To apply the same instructions across all workspaces in JetBrains IDEs, you can create a global custom instructions file on your local machine.

  1. Open your file explorer or terminal.

  2. Navigate to the appropriate location for your operating system:

    • macOS: /Users/YOUR-USERNAME/.config/github-copilot/intellij/
    • Windows: C:\Users\YOUR-USERNAME\AppData\Local\github-copilot\intellij\

  3. Create a file named global-copilot-instructions.md in that directory.

  4. Add your custom instructions in natural language, using Markdown format.

Once saved, these instructions will apply globally across all workspaces in JetBrains IDEs that you open with Copilot enabled.

Xcode supports a single .github/copilot-instructions.md custom instructions file stored in the repository.

You can create a custom instructions file in your repository via the Copilot settings page.

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.

  1. Open the GitHub Copilot for Xcode application.
  2. At the top of the application window, under Settings, click Advanced.
  3. To the right of "Custom Instructions", click Current Workspace or Global to choose whether the custom instructions apply to the current workspace or all workspaces.

VS Code supports either:

  • A single .github/copilot-instructions.md custom instructions file stored in the repository
  • One or more .instructions.md files stored within .github/instructions in the repository. Each file can specify applyTo frontmatter to define what files or directories its instructions apply to.

Using a single .github/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.

Using one or more .instructions.md files

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

  2. Create one or more .instructions.md files, adding natural language instructions to the file(s).

    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.

  3. Specify what files or directories the instructions apply to by adding applyTo frontmatter to the Markdown files, using glob syntax.

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

Add custom instructions here

    To apply the instructions to all files, use the ** pattern.

Visual Studio supports a single .github/copilot-instructions.md custom instructions file stored in the repository.

  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.

Copilot Chat on the GitHub website and Revisão de código do Copilot support a single .github/copilot-instructions.md custom instructions file stored in the repository.

In addition, Agente de codificação do Copilot supports one or more .instructions.md files stored within .github/instructions in the repository. Each file can specify applyTo frontmatter to define what files or directories its instructions apply to.

Using a single .github/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.

Using one or more .instructions.md files

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

  2. Create one or more .instructions.md files, adding natural language instructions to the file(s).

    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.

  3. Specify what files or directories the instructions apply to by adding applyTo frontmatter to the Markdown files, using glob syntax.

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

Add custom instructions here

    To apply the instructions to all files, use the ** pattern.

Did you successfully add a custom instructions file to your repository?

Yes No

Writing effective repository custom instructions

The instructions you add to your custom instruction file(s) should be short, self-contained statements that provide Copilot with relevant information to help it work in this repository. Because the instructions are sent with every chat message, they should be broadly applicable to most requests you will make in the context of the repository.

The exact structure you utilize for your instructions file(s) will vary by project and need, but the following guidelines provide a good starting point:

  • Provide an overview of the project you're working on, including its purpose, goals, and any relevant background information.
  • Include the folder structure of the repository, including any important directories or files that are relevant to the project.
  • Specify the coding standards and conventions that should be followed, such as naming conventions, formatting rules, and best practices.
  • Include any specific tools, libraries, or frameworks that are used in the project, along with any relevant version numbers or configurations.

The following instructions file(s) is an example of these practices in action:

# Project Overview

This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

## Libraries and Frameworks

- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.

## Coding Standards

- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.

## UI guidelines

- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.

You should also consider the size and complexity of your repository. The following types of instructions may work for a small repository with only a few contributors, but for a large and diverse repository, these may cause problems:

  • Requests to refer to external resources when formulating a response
  • Instructions to answer in a particular style
  • Requests to always respond with a certain level of detail

For example, the following instructions may not have the intended results:

Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.

Use @terminal when answering questions about Git.

Answer all questions in the style of a friendly colleague, using informal language.

Answer all questions in less than 1000 characters, and words of no more than 12 characters.

Repository custom instructions in use

The instructions in the file(s) are available for use by Copilot Chat as soon as you save the file(s). The complete set of instructions will be automatically added to requests that you submit to Copilot in the context of that repository. For example, they are added to the prompt you submit to Copilot Chat.

In Copilot Chat's immersive view (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 Copilot Chat, 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.

Screenshot of an expanded References list, showing the 'copilot-instructions.md' file highlighted with a dark orange outline.

You can click the reference to open the file.

Observação

  • É possível que vários tipos de instruções personalizadas se apliquem a uma conversa. Instruções pessoais assumem a prioridade mais alta, seguidas pelas instruções do repositório, com as instruções da organização priorizadas por último. No entanto, todos os conjuntos de instruções relevantes ainda são combinados e fornecidos ao Copilot Chat.
  • Sempre que possível, você deve evitar fornecer conjuntos conflitantes de instruções. Se estiver preocupado com a qualidade da resposta, você também poderá optar por desabilitar temporariamente as instruções do repositório. Confira Adding repository custom instructions for GitHub 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.

Screenshot of an expanded References list, showing the 'copilot-instructions.md' file highlighted with a dark orange outline.

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.

Screenshot of the References popup, showing the 'copilot-instructions.md' file highlighted with a dark orange outline.

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.

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.

Enabling or disabling repository custom instructions

You can choose whether or not you want Copilot to use repository-based custom instructions.

Enabling or disabling custom instructions for Copilot Chat

Custom instructions are enabled for Copilot Chat by default but you can disable, or re-enable, them at any time. This applies to your own use of Copilot Chat and does not affect other users.

  1. On GitHub.com, do one of the following:

    • Go to a repository with a custom instructions file and open the assistive chat panel.
    • Go to the immersive view of Copilot Chat (github.com/copilot) and attach a repository that contains a custom instructions file.

  2. Click the button at the top of the Chat panel, or the top right of the immersive page.

  3. Click Disable custom instructions or Enable custom instructions.

    Observação

    You will only see these options in the context of a repository that contains a custom instructions file.

Your choice persists, for all repositories containing a custom instructions file, until you change it.

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

Custom instructions are enabled for Revisão de código do 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. Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  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.

Enabling or disabling repository custom instructions

You can choose whether or not you want Copilot to use repository-based custom instructions.

Enabling or disabling custom instructions for Copilot Chat

Custom instructions are enabled for Copilot Chat by default but you can disable, or re-enable, them at any time. This applies to your own use of Copilot Chat and does not affect other users.

  1. Open the Setting editor by using the keyboard shortcut Command+, (Mac) / Ctrl+, (Linux/Windows).
  2. Type instruction file in the search box.
  3. Select or clear the checkbox under Code Generation: Use Instruction Files.

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

Custom instructions are enabled for Revisão de código do 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. Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  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.

Enabling or disabling repository custom instructions

You can choose whether or not you want Copilot to use repository-based custom instructions.

Enabling or disabling custom instructions for Copilot Chat

Custom instructions are enabled for Copilot Chat by default but you can disable, or re-enable, them at any time. This applies to your own use of Copilot Chat and does not affect other users.

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

    Screenshot of the Visual Studio menu bar. The "Tools" menu is expanded, and the "Options" item is highlighted with an orange outline.

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

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

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

Custom instructions are enabled for Revisão de código do 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. Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  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.

Enabling and using prompt files

Observação

Prompt files are versão prévia pública and subject to change.

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.

Enabling prompt files

To enable prompt files, configure the workspace settings.

  1. Open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac).
  2. Type "Open Workspace Settings (JSON)" and select the option that's displayed.
  3. In the settings.json file, add "chat.promptFiles": true to enable the .github/prompts folder as the location for prompt files. This folder will be created if it does not already exist.

Creating prompt files

  1. Open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac).

  2. Type "prompt" and select Chat: Create Prompt.

  3. Enter a name for the prompt file, excluding the .prompt.md file name extension. The name can contain alphanumeric characters and spaces and should describe the purpose of the prompt information the file will contain.

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

Using prompt files

  1. At the bottom of the Copilot Chat view, click the Attach context icon ().

  2. In the dropdown menu, click Prompt... and choose the prompt file you want to use.

  3. Optionally, attach additional files, including prompt files, to provide more context.

  4. Optionally, type additional information in the chat prompt box.

    Whether you need to do this or not depends on the contents of the prompt you are using.

  5. Submit the chat prompt.

For more information about prompt files, see Custom instructions for GitHub Copilot in VS Code in the Visual Studio Code documentation.