GitHub Copilot peut fournir des réponses adaptées à vos préférences personnelles, à la façon dont votre équipe fonctionne, aux outils que vous utilisez ou aux spécificités de votre projet, si vous lui fournissez suffisamment de contexte pour le faire. Au lieu d’ajouter à plusieurs reprises ces détails contextuels à vos demandes, vous pouvez créer des instructions personnalisées qui ajoutent automatiquement ces informations pour vous. Les informations supplémentaires ne s’affichent pas, mais sont disponibles pour Copilot pour lui permettre de générer des réponses de qualité supérieure.
Types d’instructions personnalisées
CLI de GitHub Copilot prend en charge les types suivants d'instructions personnalisées.
Instructions personnalisées à l’échelle du référentiel
Celles-ci s’appliquent à toutes les demandes effectuées dans le contexte d’un référentiel.
Ceux-ci sont spécifiés dans un fichier copilot-instructions.md dans le répertoire .github à la racine du référentiel. Consultez Création d’instructions personnalisées à l’échelle du dépôt.
Instructions personnalisées spécifiques au chemin d’accès
Celles-ci s’appliquent aux requêtes effectuées dans le contexte des fichiers qui correspondent à un chemin d’accès spécifié.
Ceux-ci sont spécifiés dans un ou plusieurs fichiers NAME.instructions.md au sein ou en dessous du répertoire .github/instructions à la racine du référentiel, ou au sein ou en dessous d’un répertoire .github/instructions dans le répertoire de travail actif. Consultez Création d’instructions personnalisées spécifiques d’un chemin d’accès.
Si le chemin que vous spécifiez dans ces instructions correspond à un fichier sur lequel Copilot fonctionne et qu’un fichier d’instructions personnalisées à l’échelle du référentiel existe également, les instructions des deux fichiers sont utilisées. Vous devez éviter les conflits potentiels entre les instructions, car le choix de Copilot entre les instructions en conflit n’est pas déterministe.
Instructions de l’assistant
Ceux-ci sont utilisés par différents agents IA.
Vous pouvez créer un ou plusieurs AGENTS.md fichiers. Ceux-ci peuvent se trouver dans le répertoire racine du référentiel, dans le répertoire de travail actif ou dans l’un des répertoires spécifiés par une liste de chemins séparés par des virgules dans la COPILOT_CUSTOM_INSTRUCTIONS_DIRS variable d’environnement.
Les instructions contenues dans le fichier dans le AGENTS.md répertoire racine, le cas échéant, sont traitées comme des instructions principales. Si un fichier AGENTS.md et un fichier .github/copilot-instructions.md se trouvent à la racine du référentiel, les instructions des deux fichiers sont utilisées.
Les instructions trouvées dans d’autres AGENTS.md fichiers sont traitées comme des instructions supplémentaires. Toutes les instructions principales trouvées ont généralement un effet plus important sur les réponses de Copilot que d'autres instructions.
Pour plus d’informations, consultez le dépôt agentsmd/agents.md.
Vous pouvez également utiliser des fichiers CLAUDE.md et GEMINI.md. Celles-ci doivent se trouver à la racine du référentiel.
Instructions locales
Celles-ci s’appliquent dans un environnement local spécifique.
Vous pouvez spécifier des instructions dans votre propre répertoire de base, en créant un fichier à l’adresse $HOME/.copilot/copilot-instructions.md.
Vous pouvez également définir la COPILOT_CUSTOM_INSTRUCTIONS_DIRS variable d’environnement sur une liste de répertoires séparés par des virgules. Copilot CLI recherche un fichier AGENTS.md et tous les fichiers .github/instructions/**/*.instructions.md, dans chacun de ces répertoires.
Création d’instructions personnalisées à l’échelle du dépôt
-
À la racine de votre référentiel, créez un fichier nommé
.github/copilot-instructions.md.Créez le répertoire
.githubs’il n’existe pas déjà. -
Ajouter des instructions en langage naturel dans le fichier, au format Markdown.
L’espacement entre les instructions est ignoré, de sorte que les instructions peuvent être écrites dans un seul paragraphe, chacune sur une nouvelle ligne, ou séparées par des lignes vides pour plus de lisibilité.
Pour obtenir de l’aide sur l’écriture d’instructions personnalisées efficaces, consultez À propos de la personnalisation des réponses GitHub Copilot.
Création d’instructions personnalisées spécifiques à un chemin
-
Créez le
.github/instructionsrépertoire s'il n'existe pas déjà. -
Si vous le souhaitez, créez des sous-répertoires de
.github/instructionspour organiser vos fichiers d’instructions. -
Créez un ou plusieurs fichiers
NAME.instructions.md, oùNAMEindique l’objectif des instructions. Le nom de fichier doit se terminer par.instructions.md. -
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 _pas_`src/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.py`et `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`.
-
-
Si vous le souhaitez, pour empêcher l’utilisation du fichier par Copilot, agent de codage ou révision du code Copilot, ajoutez le mot clé
excludeAgentau bloc frontmatter. Utilisez l’une ou l’autre"code-review"ou"coding-agent".Par exemple, le fichier suivant est lu uniquement par Copilot, agent de codage.
--- applyTo: "**" excludeAgent: "code-review" ---Si le mot clé
excludeAgentn’est pas inclus dans le front matterblock, révision du code Copilot et Copilot, agent de codage utiliseront vos instructions. -
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é.
Avez-vous réussi à ajouter un fichier d’instructions personnalisé à votre référentiel ?
<a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
<span>Oui</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>Non</span></a>
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.
Si vous apportez des modifications à vos instructions personnalisées pendant une session CLI, vos modifications sont disponibles pour une utilisation par Copilot la prochaine fois que vous envoyez une invite dans les sessions actuelles ou futures.
Lectures complémentaires
-
[AUTOTITLE](/copilot/reference/custom-instructions-support) -
[AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions) : collection organisée d’exemples -
[AUTOTITLE](/copilot/tutorials/use-custom-instructions)