---
title: Adding repository custom instructions for GitHub Copilot
shortTitle: Repository custom instructions
intro: 'Create a file in a repository that gives {% data variables.product.prodname_copilot_short %} additional context for the work it does in that repository.'
redirect_from:
- /copilot/customizing-copilot/adding-custom-instructions-for-github-copilot
- /copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot
versions:
feature: copilot
topics:
- Copilot
---
{% webui %}
> [!NOTE] This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change.
This version of this article is for using repository custom instructions on the {% data variables.product.github %} website. Click the tabs above for information on using custom instructions in other environments.
## About repository custom instructions for {% data variables.product.prodname_copilot_short %}
Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. For a full introduction to custom instructions, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=webui).
{% data reusables.copilot.repository-custom-instructions-support %}
* **{% data variables.copilot.copilot_coding_agent %}**
* **{% data variables.copilot.copilot_code-review_short %}**
{% endwebui %}
{% vscode %}
This version of this article is for using repository custom instructions and prompt files in {% data variables.product.prodname_vscode_shortname %}. Click the tabs above for instructions on using custom instructions in other environments.
## About repository custom instructions and prompt files for {% data variables.product.prodname_copilot_short %}
You can provide {% data variables.product.prodname_copilot_short %} with repository-wide instructions or reusable prompt files to give it context and guidance when working in {% data variables.product.prodname_vscode_shortname %}. For a full introduction to repository custom instructions and prompt files, including examples, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=vscode).
{% data reusables.copilot.repository-custom-instructions-support %}
* **{% data variables.copilot.copilot_code-review_short %}**
{% endvscode %}
{% visualstudio %}
> [!NOTE] This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change.
This version of this article is for using repository custom instructions in {% data variables.product.prodname_vs %}. Click the tabs above for instructions on using custom instructions in other environments.
## About repository custom instructions for {% data variables.product.prodname_copilot_short %}
Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. For a full introduction to custom instructions, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=visualstudio).
{% data reusables.copilot.repository-custom-instructions-support %}
* **{% data variables.copilot.copilot_code-review_short %}**
{% endvisualstudio %}
{% jetbrains %}
> [!NOTE] This feature is currently in {% data variables.release-phases.public_preview %} 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.
## About repository custom instructions for {% data variables.copilot.copilot_chat %}
Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. For a full introduction to custom instructions, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=jetbrains).
{% data reusables.copilot.repository-custom-instructions-support %}
{% endjetbrains %}
{% xcode %}
> [!NOTE] This feature is currently in {% data variables.release-phases.public_preview %} 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 {% data variables.copilot.copilot_chat %}
Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. For a full introduction to custom instructions, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=xcode).
{% data reusables.copilot.repository-custom-instructions-support %}
{% endxcode %}
## Prerequisites for repository custom instructions
* You must have a custom instructions file (see the instructions below).
{% webui %}
* Your personal choice of whether to use custom instructions must be set to enabled. This is enabled by default. See [Enabling or disabling repository custom instructions](#enabling-or-disabling-repository-custom-instructions) later in this article.
* During the {% data variables.release-phases.public_preview %}, if you're using a {% data variables.copilot.copilot_business_short %} {% ifversion ghec %}or {% data variables.copilot.copilot_enterprise_short %}{% endif %} plan, the organization {% ifversion ghec %}or enterprise{% endif %} that provides your plan must have the **Opt in to preview features** setting enabled. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization){% ifversion ghec %} and [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom){% endif %}.
{% endwebui %}
{% vscode %}
* The **Use Instruction Files** option must be enabled in your settings. This is enabled by default. See [Enabling or disabling repository custom instructions](#enabling-or-disabling-repository-custom-instructions) later in this article.
{% endvscode %}
{% visualstudio %}
* The **Enable custom instructions** option must be enabled in your settings. This is disabled by default. See [Enabling or disabling repository custom instructions](#enabling-or-disabling-repository-custom-instructions) later in this article.
{% endvisualstudio %}
{% jetbrains %}
* The latest version of the {% data variables.product.prodname_copilot_short %} extension must be installed in your JetBrains IDE.
{% endjetbrains %}
{% xcode %}
* The latest version of the {% data variables.product.prodname_copilot_short %} extension must be installed in Xcode.
{% endxcode %}
## Creating a repository custom instructions file
{% jetbrains %}
You can create a custom instructions file in your repository using the {% data variables.product.prodname_copilot_short %} 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
{% data reusables.copilot.jetbrains-settings %}
{% data reusables.copilot.jetbrains-languages-and-frameworks %}
1. Under "{% data variables.product.prodname_copilot_short %} 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.
1. 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 {% data variables.product.prodname_copilot_short %} 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.
1. 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\`
1. Create a file named `global-copilot-instructions.md` in that directory.
1. 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 {% data variables.product.prodname_copilot_short %} enabled.
{% endjetbrains %}
{% xcode %}
You can create a custom instructions file in your repository via the {% data variables.product.prodname_copilot_short %} 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 {% data variables.product.prodname_copilot %} for Xcode application.
1. At the top of the application window, under **Settings**, click **Advanced**.
1. 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.
{% endxcode %}
{% vscode %}
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.
1. 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.
{% endvscode %}
{% visualstudio %}
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.
1. 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.
{% endvisualstudio %}
{% webui %}
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.
1. 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.
To see your instructions in action, go to [https://github.com/copilot](https://github.com/copilot), attach the repository containing the instructions file, and start a conversation.
{% endwebui %}
{% note %}
Did you successfully add a custom instructions file to your repository?
Yes No
{% endnote %}
## Repository custom instructions in use
The instructions in the `.github/copilot-instructions.md` file are available for use by {% data variables.copilot.copilot_chat_short %} as soon as you save the file. The complete set of instructions will be automatically added to requests that you submit to {% data variables.product.prodname_copilot_short %} in the context of that repository. For example, they are added to the prompt you submit to {% data variables.copilot.copilot_chat_short %}.
{% webui %}
In {% data variables.copilot.copilot_chat_short %}'s immersive view ([github.com/copilot](https://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 {% data variables.copilot.copilot_chat_short %}, 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.
{% data reusables.copilot.custom-instructions-interactions-note %}
{% endwebui %}
{% vscode %}
{% data reusables.copilot.custom-instructions-reference %}
{% endvscode %}
{% visualstudio %}
{% data reusables.copilot.custom-instructions-reference %}
{% endvisualstudio %}
{% jetbrains %}
{% data reusables.copilot.custom-instructions-reference %}
{% endjetbrains %}
{% xcode %}
{% data reusables.copilot.custom-instructions-reference %}
{% endxcode %}
{% webui %}
{% data reusables.copilot.custom-instructions-enabling %}
1. On {% data variables.product.prodname_dotcom_the_website %}, 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 {% data variables.copilot.copilot_chat_short %} ([github.com/copilot](https://github.com/copilot)) and attach a repository that contains a custom instructions file.
1. Click the {% octicon "kebab-horizontal" aria-label="Conversation options" %} button at the top of the Chat panel, or the top right of the immersive page.
1. Click **Disable custom instructions** or **Enable custom instructions**.
> [!NOTE]
> 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.
{% data reusables.copilot.custom-instructions-enabling-for-ccr %}
{% endwebui %}
{% vscode %}
{% data reusables.copilot.custom-instructions-enabling %}
1. Open the Setting editor by using the keyboard shortcut Command+, (Mac) / Ctrl+, (Linux/Windows).
1. Type `instruction file` in the search box.
1. Select or clear the checkbox under **Code Generation: Use Instruction Files**.
{% data reusables.copilot.custom-instructions-enabling-for-ccr %}
{% endvscode %}
{% visualstudio %}
{% data reusables.copilot.custom-instructions-enabling %}
1. In the {% data variables.product.prodname_vs %} menu bar, under **Tools**, click **Options**.
1. In the "Options" dialog, type `custom instructions` in the search box, then click **{% data variables.product.prodname_copilot_short %}**.
1. Select or clear the checkbox for **(Preview) Enable custom instructions to be loaded from .github/copilot-instructions.md files and added to requests**.
{% data reusables.copilot.custom-instructions-enabling-for-ccr %}
{% endvisualstudio %}
{% vscode %}
## Enabling and using prompt files
> [!NOTE] Prompt files are {% data variables.release-phases.public_preview %} 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 {% data variables.copilot.copilot_chat_short %} (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).
1. Type "Open Workspace Settings (JSON)" and select the option that's displayed.
1. 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).
1. Type "prompt" and select **Chat: Create Prompt**.
1. 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.
1. 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 {% data variables.copilot.copilot_chat_short %} view, click the **Attach context** icon ({% octicon "paperclip" aria-hidden="true" aria-label="paperclip" %}).
1. In the dropdown menu, click **Prompt...** and choose the prompt file you want to use.
1. Optionally, attach additional files, including prompt files, to provide more context.
1. 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.
1. Submit the chat prompt.
For more information about prompt files, see [Custom instructions for {% data variables.product.prodname_copilot %} in VS Code](https://code.visualstudio.com/docs/copilot/copilot-customization#_reusable-prompt-files-experimental) in the {% data variables.product.prodname_vscode %} documentation.
{% endvscode %}