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.

Présentation

Les instructions personnalisées du référentiel vous permettent de fournir à Copilot des instructions et des préférences spécifiques au référentiel. Pour plus d’informations, consultez « À propos de la personnalisation des réponses GitHub Copilot ».

Conditions préalables pour les instructions personnalisées du référentiel

• Vous devez disposer d'un fichier d'instructions personnalisé (voir les instructions ci-dessous).

• 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 À propos de la personnalisation des réponses 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. Créez le .github/instructions répertoire s'il n'existe pas déjà.

2. Si vous le souhaitez, créez des sous-répertoires de .github/instructions pour organiser vos fichiers d’instructions.

3. Créez un ou plusieurs fichiers NAME.instructions.md, où NAME indique l’objectif des instructions. Le nom de fichier doit se terminer par .instructions.md.

4. Au début du fichier, créez un bloc frontmatter contenant le mot-clé applyTo. Utilisez la syntaxe glob pour spécifier les fichiers ou répertoires auxquels les instructions s’appliquent.

   Par exemple :

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

   Vous pouvez spécifier plusieurs modèles en les séparant par des virgules. Par exemple, pour appliquer les instructions à tous les fichiers TypeScript du référentiel, vous pouvez utiliser le bloc frontmatter suivant :

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

   Exemples Glob :

   • * - correspond à tous les fichiers du répertoire en cours.
   • ** ou **/* - correspond à tous les fichiers de tous les répertoires.
   • *.py - correspond à tous les .py fichiers du répertoire actif.
   • **/*.py - correspond de manière récursive à tous les .py fichiers de tous les répertoires.
   • src/*.py - correspond à tous les .py fichiers du src répertoire. Par exemple, src/foo.py et src/bar.py mais passrc/foo/bar.py.
   • src/**/*.py - correspond de manière récursive à tous les .py fichiers du src répertoire. Par exemple, src/foo.py, src/foo/bar.pyet src/foo/bar/baz.py.

   •           `**/subdir/**/*.py` - correspond de manière récursive à tous les `.py` fichiers d’un répertoire à n’importe quelle `subdir` profondeur. Par exemple, `subdir/foo.py`, `subdir/nested/bar.py`, `parent/subdir/baz.py` et `deep/parent/subdir/nested/qux.py`, mais _pas_`foo.py` à un chemin qui ne contient pas de répertoire `subdir`.
     

5. Si vous le souhaitez, pour empêcher l’utilisation du fichier par Copilot cloud agent ou Copilot code review, ajoutez le mot clé excludeAgent au bloc frontmatter. Utilisez l’une ou l’autre "code-review" ou "cloud-agent".

   Par exemple, le fichier suivant est lu uniquement par Copilot cloud agent.

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

   Si le mot clé excludeAgent n’est pas inclus dans le front matterblock, Copilot code review et Copilot cloud agent utiliseront vos instructions.

6. Ajoutez vos instructions personnalisées en langage naturel à l’aide du format Markdown. L'espacement entre les instructions est ignoré, de sorte que les instructions peuvent être écrites comme un seul paragraphe, chacune sur une nouvelle ligne, ou séparées par des lignes vides pour plus de lisibilité.

Instructions personnalisées en cours d’utilisation

Les instructions du fichier ou des fichiers sont disponibles pour une utilisation par Copilot dès que vous enregistrez le fichier ou les fichiers. Les instructions sont automatiquement ajoutées aux demandes que vous envoyez à Copilot.

Les instructions personnalisées ne sont pas visibles dans la vue Chat ou dans le chat en ligne, mais vous pouvez vérifier qu'elles sont utilisées par Copilot en consultant la liste des références d'une réponse dans la vue Chat. Si des instructions personnalisées ont été ajoutées à l'invite envoyée au modèle, le fichier .github/copilot-instructions.md est indiqué comme référence. Vous pouvez cliquer sur la référence pour ouvrir le fichier.

Activation ou désactivation des instructions personnalisées du référentiel

Vous pouvez choisir si vous souhaitez ou non que Copilot utilise des instructions personnalisées basées sur le référentiel.

Activer ou désactiver les instructions personnalisées pour Copilot Chat

Les instructions personnalisées sont activées par défaut pour Copilot Chat, mais vous pouvez les désactiver ou les réactiver à tout moment. Cela s'applique à votre propre utilisation de Copilot Chat et n'affecte pas les autres utilisateurs.

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.

   

Activation ou désactivation d’instructions personnalisées pour Copilot code review

Les instructions personnalisées sont activées par défaut pour Copilot code review, mais vous pouvez les désactiver ou les réactiver dans les paramètres du référentiel de GitHub.com. Cela s’applique à l’utilisation par Copilot d’instructions personnalisées pour toutes les revues de code qu’il effectue dans ce référentiel.

1. Sur GitHub, accédez à la page principale du référentiel.

2. Sous le nom de votre référentiel, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

   

3. Dans la barre latérale, sous « Code, planification et automatisation », cliquez sur Copilot, puis Révision du code.

4. Activez ou désactivez l’option « Utiliser des instructions personnalisées lors de l’examen des 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

• Prise en charge de différents types d’instructions personnalisées
• Bibliothèque de personnalisation—a curated collection of examples
• Utilisation d'instructions personnalisées pour exploiter le potentiel de la révision de code avec Copilot.