Skip to main content

À propos de la personnalisation des réponses GitHub Copilot

Découvrez comment personnaliser le comportement de GitHub Copilot pour répondre à vos préférences et exigences.

Remarque

Cette version de cet article concerne les instructions personnalisées sur le GitHub site web. Cliquez sur les onglets ci-dessus pour découvrir d’autres environnements.

À propos de la personnalisation des Copilot réponses

          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 le fournissez avec 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 sont pas affichées, mais elles sont disponibles pour permettre à Copilot de générer des réponses de meilleure qualité.

Remarque

En raison de la nature non déterministe de l’IA, Copilot peut ne pas toujours suivre vos instructions personnalisées de la même façon chaque fois qu’elles sont utilisées.

Types d’instructions personnalisées

Il existe trois types principaux d’instructions personnalisées que vous pouvez utiliser pour personnaliser Copilot les réponses sur le GitHub site web :


          [Les instructions personnelles](#about-personal-instructions)** s’appliquent à toutes les conversations que vous avez sur le site web de Copilot ChatGitHub. Ils vous permettent de définir vos préférences individuelles, telles que la langue ou le style de réponse souhaités, afin que les réponses soient adaptées à vos besoins personnels.

          [Les instructions personnalisées](#about-repository-custom-instructions)** du référentiel s’appliquent aux conversations dans le contexte d’un référentiel spécifique. Ils sont utiles pour définir des normes de codage, des cadres ou des outils spécifiques à un projet. Par exemple, vous pouvez indiquer qu’un référentiel utilise TypeScript et une bibliothèque spécifique, garantissant ainsi des réponses cohérentes pour tous les contributeurs.

          [Les instructions personnalisées](#about-organization-custom-instructions)** de l’organisation s’appliquent aux conversations dans le contexte d’une organisation sur le GitHub site web. Ils sont particulièrement adaptés pour appliquer des préférences à l’échelle de l’organisation, telles qu’un langage commun ou des directives de sécurité. Les instructions personnalisées de l’organisation ne peuvent être définies que par les propriétaires d'une organisation avec un Copilot Business ou Copilot Entreprise abonnement.

À propos des instructions personnelles

Remarque

Les instructions personnalisées personnelles ne sont prises en charge que pour GitHub Copilot Chat dans GitHub.

Vous pouvez personnaliser la façon dont Copilot Chat répond GitHub.com en ajoutant des instructions personnelles qui Copilot ne s’appliqueront qu’à vous. Vous effectuez cette opération dans une fenêtre contextuelle de la Copilot Chat page sur GitHub.com. Consultez Adding personal custom instructions for GitHub Copilot.

À propos des instructions personnalisées du référentiel

Vous pouvez utiliser trois types d’instructions personnalisées de référentiel dans Copilot :GitHub.com

  • Instructions personnalisées à l’échelle du référentiel, qui s’appliquent à toutes les requêtes effectuées dans le contexte d’un référentiel.

    Celles-ci sont spécifiées dans un fichier copilot-instructions.md situé dans le répertoire .github du référentiel.

  • Instructions personnalisées spécifiques à un chemin d’accès, qui s’appliquent aux requêtes effectuées dans le contexte de fichiers correspondant à un chemin d’accès spécifié.

    Ceux-ci sont spécifiés dans un ou plusieurs NAME.instructions.md fichiers dans ou sous le .github/instructions répertoire du référentiel.

    En utilisant des instructions spécifiques à un chemin d’accès, vous pouvez éviter de surcharger vos instructions à l’échelle du référentiel avec des informations qui ne s’appliquent qu’à certains types de fichiers ou à certains répertoires.

  • Les instructions de l’agent, qui sont similaires aux instructions personnalisées à l’échelle du référentiel, mais ne sont pas encore prises en charge par toutes les fonctionnalités de Copilot.

    Ceux-ci sont spécifiés dans les fichiers appelés AGENTS.md, CLAUDE.mdou GEMINI.md.

Pour plus d’informations sur la prise en charge de chacun de ces types d’instructions personnalisées de référentiel sur différentes Copilot fonctionnalités, consultez Prise en charge de différents types d’instructions personnalisées.

Pour obtenir une collection organisée d’exemples, consultez Instructions personnalisées.

À propos des instructions personnalisées de l’organisation

Remarque

          **Soutien:** Les instructions personnalisées de l’organisation sont actuellement uniquement prises en charge pour Copilot Chat on GitHub.com, révision du code Copilot on GitHub.com et Agent cloud Copilot on GitHub.com.

Les propriétaires de l’organisation peuvent ajouter des instructions pour Copilot, pour adapter les réponses aux besoins et préférences de votre organisation. Par exemple, vous pouvez choisir de toujours répondre Copilot dans la langue de votre entreprise ou avec un style particulier.

Les instructions personnalisées définies dans les paramètres d’une Copilot organisation sont utilisées pour tous les membres de l’organisation, qu’ils reçoivent leur Copilot abonnement de cette organisation ou non.

Voici quelques exemples d’instructions que vous pourriez ajouter :

  • Always respond in Spanish.
  • Do not generate code blocks in responses.
  • For questions related to security, use the Security Docs Knowledge Base.

Priorité des instructions personnalisées

Plusieurs types d’instructions personnalisées peuvent s’appliquer à une demande envoyée à Copilot. Les instructions personnelles prennent la priorité la plus élevée. Les instructions du référentiel viennent ensuite, puis les instructions de l’organisation sont classées par ordre de priorité en dernier. Toutefois, tous les ensembles d’instructions pertinentes sont transmis à Copilot.

La liste suivante montre l’ordre de priorité complet, avec des instructions plus élevées dans cette liste qui sont prioritaires sur celles inférieures de la liste :

  • Instructions personnelles
  • Instructions personnalisées pour le référentiel : * Instructions spécifiques au chemin dans tout fichier .github/instructions/**/*.instructions.md applicable
    •           **Instructions applicables à l’ensemble** du référentiel dans le fichier `.github/copilot-instructions.md`
      
    • Instructions de l’agent (par exemple, dans un AGENTS.md fichier)
  • Organisation instructions personnalisées

Dans la mesure du possible, essayez d’éviter de fournir des ensembles d’instructions en conflit. Si vous êtes préoccupé par la qualité de la réponse, vous pouvez désactiver temporairement les instructions du référentiel. Consultez Adding repository custom instructions for GitHub Copilot.

Utilisation d’instructions personnalisées

Les instructions personnalisées sont rédigées en langage naturel et sont plus efficaces lorsqu’elles sont courtes et autonomes. Considérez l’étendue sur laquelle vous souhaitez que l’instruction s’applique lorsque vous choisissez d’ajouter une instruction au niveau personnel, référentiel ou organisation.

Voici quelques cas d’utilisation courants et exemples pour chaque type d’instructions personnalisées :

  • Instructions personnelles :
    • Langue individuelle préférée : Always respond in Portuguese.
    • Préférences individuelles en matière de réponse : Explain a single concept per line. Be clear and concise.
  • Instructions personnalisées du référentiel :
    • Normes de codage : Use early returns whenever possible.
    • Frameworks : Use Vue with the PrimeVue library. ou Use Typescript rather than Javascript.
    • Préférences de style de code : Use camel case for variable names.
  • Instructions spécifiques à l’organisation :
    • Décrire comment répondre à certaines questions : For questions related to security, use the Security Docs Knowledge Base or advise people to consult with #security on Slack.
    • Langue préférée pour une entreprise qui utilise exclusivement une seule langue : Always respond in Portuguese.
    • Préférences à l’échelle de l’organisation : Do not generate code blocks in responses.

Remarque

* révision du code Copilot lit uniquement les 4 000 premiers caractères d’un fichier d’instructions personnalisé. Toutes les instructions au-delà de cette limite n’affectent pas les révisions générées par révision du code Copilot. Cette limite ne s'applique pas à Copilot Chat ou à Agent cloud Copilot.

  • Lors de l’examen d’une demande de tirage, Copilot utilise les instructions personnalisées dans la branche de base de la demande de tirage. Par exemple, si votre demande de tirage cherche à fusionner my-feature-branch dans main, Copilot va utiliser les instructions personnalisées dans main.

Rédiger des instructions personnalisées efficaces

Les instructions que vous ajoutez à votre (vos) fichier(s) d'instructions personnalisé(s) doivent être courtes et autonomes, et fournir à Copilot les informations pertinentes pour l'aider à fonctionner dans ce référentiel. Les instructions étant envoyées avec chaque message de conversation, elles doivent être largement applicables à la plupart des demandes que vous effectuerez dans le contexte du référentiel.

La structure exacte que vous utilisez pour vos fichiers d’instructions varie selon le projet et les besoins, mais les instructions suivantes fournissent un bon point de départ :

  • Fournissez une vue d’ensemble du projet sur lequel vous travaillez, y compris son intention, ses objectifs et toutes les informations contextuelles pertinentes.
  • Indiquez la structure des dossiers du référentiel, y compris les répertoires ou fichiers pertinents pour le projet.
  • Spécifier les normes et conventions de codage à respecter, telles que les conventions de dénomination, les règles de formatage et les meilleures pratiques.
  • Indiquez tous les outils, bibliothèques ou cadres spécifiques utilisés dans le projet, ainsi que les numéros de version ou les configurations correspondantes.

Le fichier d’instructions suivant est un exemple de ces pratiques en 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.

Vous devez également tenir compte de la taille et de la complexité de votre référentiel. Les types d'instructions suivants peuvent fonctionner pour un petit référentiel avec seulement quelques contributeurs, mais pour un référentiel vaste et diversifié, **ils peuvent poser des problèmes ** :

  • Demandes de référence à des ressources externes lors de la formulation d'une réponse
  • Instructions pour répondre dans un style particulier
  • Demande de toujours répondre avec un certain niveau de détail

Par exemple, les instructions suivantes ** peuvent ne pas donner les résultats escomptés ** :

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.

Étapes suivantes

Lectures complémentaires

Remarque

Cette version de cet article traite des instructions personnalisées et des fichiers prompts dans VS Code. Cliquez sur les onglets ci-dessus pour découvrir d’autres environnements.

À propos de la personnalisation des Copilot réponses

          GitHub Copilot peut fournir des réponses adaptées au fonctionnement de votre équipe, aux outils que vous utilisez ou aux spécificités de votre projet, si vous fournissez suffisamment de contexte pour le faire. Au lieu d’ajouter à plusieurs reprises ces détails contextuels à vos invites, vous pouvez créer des fichiers dans votre référentiel qui ajoutent automatiquement ces informations pour vous.

Il existe deux types de fichiers que vous pouvez utiliser pour fournir un contexte et des instructions dans CopilotVS Code:

  • Les instructions personnalisées du référentiel vous permettent de spécifier des instructions et des préférences qui Copilot seront à prendre en compte lors de l’utilisation dans le contexte du référentiel.
  • Les fichiers d’invites (version préliminaire publique) vous permettent d’enregistrer des instructions courantes et le contexte pertinent dans des fichiers Markdown (*.prompt.md) que vous pouvez ensuite réutiliser dans vos invites de chat. Les fichiers d’invite sont disponibles uniquement dans VS Code, Visual Studio, et les IDE JetBrains.

Alors que les instructions personnalisées permettent d’ajouter un contexte à l’échelle du code à chaque flux de travail de l’IA, les fichiers d’invite vous permettent d’ajouter des instructions à une interaction de chat spécifique.

Remarque

En raison de la nature non déterministe de l’IA, Copilot peut ne pas toujours suivre vos instructions personnalisées de la même façon chaque fois qu’elles sont utilisées.

À propos des instructions personnalisées du référentiel

Vous pouvez utiliser trois types d’instructions personnalisées de référentiel dans VS Code:

  • Instructions personnalisées à l’échelle du référentiel, qui s’appliquent à toutes les requêtes effectuées dans le contexte d’un référentiel.

    Celles-ci sont spécifiées dans un fichier copilot-instructions.md situé dans le répertoire .github du référentiel.

  • Instructions personnalisées spécifiques à un chemin d’accès, qui s’appliquent aux requêtes effectuées dans le contexte de fichiers correspondant à un chemin d’accès spécifié.

    Ceux-ci sont spécifiés dans un ou plusieurs NAME.instructions.md fichiers dans ou sous le .github/instructions répertoire du référentiel.

    En utilisant des instructions spécifiques à un chemin d’accès, vous pouvez éviter de surcharger vos instructions à l’échelle du référentiel avec des informations qui ne s’appliquent qu’à certains types de fichiers ou à certains répertoires.

  • Les instructions de l’agent, qui sont similaires aux instructions personnalisées à l’échelle du référentiel, mais ne sont pas encore prises en charge par toutes les fonctionnalités de Copilot.

    Ceux-ci sont spécifiés dans les fichiers appelés AGENTS.md, CLAUDE.mdou GEMINI.md.

Pour plus d’informations sur la prise en charge de chacun de ces types d’instructions personnalisées de référentiel sur différentes Copilot fonctionnalités, consultez Prise en charge de différents types d’instructions personnalisées.

Pour obtenir une collection organisée d’exemples, consultez Instructions personnalisées.

À propos des fichiers d’invite

Remarque

Les fichiers d’invite sont préversion publique et susceptibles de changer.

Les fichiers d’invite vous permettent de créer et de partager des instructions d’invite réutilisables avec un contexte supplémentaire. Un fichier d’invite est un fichier Markdown, stocké dans votre espace de travail, qui imite le format existant de rédaction des invites dans Copilot Chat (par exemple, Rewrite #file:x.ts). Cela permet de combiner des instructions en langage naturel, du contexte supplémentaire et même des liens vers d’autres fichiers d’invites en tant que dépendances.

Les cas d’utilisation courants sont les suivants :

  • Génération de code. Créez des invites réutilisables pour les composants, les tests ou les migrations (par exemple, les formulaires React ou les simulations d’API).
  • Expertise du domaine. Partagez des connaissances spécialisées à l’aide d’invites, telles que des pratiques de sécurité ou des contrôles de conformité.
  • Collaboration en équipe. Documentez les modèles et les directives en incluant des références aux spécifications et à la documentation.
  • Intégration. Créez des guides pas à pas pour des processus complexes ou des modèles spécifiques à un projet.

Vous pouvez disposer de plusieurs fichiers d’invite dans votre espace de travail, chacun définissant une invite à des fins différentes.

Exemples

Les exemples suivants illustrent l’utilisation des fichiers d’invite.

  • New React form.prompt.md : contient des instructions pour une tâche réutilisable permettant de générer un formulaire à l’aide de React.

    Your goal is to generate a new React form component.
    
    Ask for the form name and fields if not provided.
    
    Requirements for the form:
    - Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
    - Use `react-hook-form` for form state management:
      - Always define TypeScript types for your form data
      - Prefer *uncontrolled* components using register
      - Use `defaultValues` to prevent unnecessary rerenders
    - Use `yup` for validation:
      - Create reusable validation schemas in separate files
      - Use TypeScript types to ensure type safety
      - Customize UX-friendly validation rules
    
  • API security review.prompt.md — contient des informations réutilisables sur les pratiques de sécurité pour les API REST, qui peuvent être utilisées pour effectuer des révisions de sécurité des API REST.

    Secure REST API review:
    - Ensure all endpoints are protected by authentication and authorization
    - Validate all user inputs and sanitize data
    - Implement rate limiting and throttling
    - Implement logging and monitoring for security events
    …
    

Pour plus d’informations sur l’activation, la création et l’utilisation des fichiers d’invite, consultez Adding repository custom instructions for GitHub Copilot.

Rédiger des instructions personnalisées efficaces

Les instructions que vous ajoutez à votre (vos) fichier(s) d'instructions personnalisé(s) doivent être courtes et autonomes, et fournir à Copilot les informations pertinentes pour l'aider à fonctionner dans ce référentiel. Les instructions étant envoyées avec chaque message de conversation, elles doivent être largement applicables à la plupart des demandes que vous effectuerez dans le contexte du référentiel.

La structure exacte que vous utilisez pour vos fichiers d’instructions varie selon le projet et les besoins, mais les instructions suivantes fournissent un bon point de départ :

  • Fournissez une vue d’ensemble du projet sur lequel vous travaillez, y compris son intention, ses objectifs et toutes les informations contextuelles pertinentes.
  • Indiquez la structure des dossiers du référentiel, y compris les répertoires ou fichiers pertinents pour le projet.
  • Spécifier les normes et conventions de codage à respecter, telles que les conventions de dénomination, les règles de formatage et les meilleures pratiques.
  • Indiquez tous les outils, bibliothèques ou cadres spécifiques utilisés dans le projet, ainsi que les numéros de version ou les configurations correspondantes.

Le fichier d’instructions suivant est un exemple de ces pratiques en 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.

Vous devez également tenir compte de la taille et de la complexité de votre référentiel. Les types d'instructions suivants peuvent fonctionner pour un petit référentiel avec seulement quelques contributeurs, mais pour un référentiel vaste et diversifié, **ils peuvent poser des problèmes ** :

  • Demandes de référence à des ressources externes lors de la formulation d'une réponse
  • Instructions pour répondre dans un style particulier
  • Demande de toujours répondre avec un certain niveau de détail

Par exemple, les instructions suivantes ** peuvent ne pas donner les résultats escomptés ** :

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.

Étapes suivantes

Remarque

Cette version de cet article concerne les instructions personnalisées et les fichiers d’invite dans Visual Studio. Cliquez sur les onglets ci-dessus pour découvrir d’autres environnements.

À propos de la personnalisation des Copilot réponses

          GitHub Copilot peut fournir des réponses adaptées au fonctionnement de votre équipe, aux outils que vous utilisez ou aux spécificités de votre projet, si vous fournissez suffisamment de contexte pour le faire. Au lieu d’ajouter à plusieurs reprises ces détails contextuels à vos invites, vous pouvez créer des fichiers dans votre référentiel qui ajoutent automatiquement ces informations pour vous.

Il existe deux types de fichiers que vous pouvez utiliser pour fournir un contexte et des instructions dans CopilotVisual Studio:

  • Les instructions personnalisées du référentiel vous permettent de spécifier des instructions et des préférences qui Copilot seront à prendre en compte lors de l’utilisation dans le contexte du référentiel.
  • Les fichiers d’invite vous permettent d’enregistrer les instructions d’invite courantes et le contexte pertinent dans les fichiers Markdown (*.prompt.md) que vous pouvez ensuite réutiliser dans vos invites de conversation. Les fichiers d’invite sont disponibles uniquement dans VS Code, Visual Studio, et les IDE JetBrains.

Alors que les instructions personnalisées permettent d’ajouter un contexte à l’échelle du code à chaque flux de travail de l’IA, les fichiers d’invite vous permettent d’ajouter des instructions à une interaction de chat spécifique.

Remarque

En raison de la nature non déterministe de l’IA, Copilot peut ne pas toujours suivre vos instructions personnalisées de la même façon chaque fois qu’elles sont utilisées.

À propos des instructions personnalisées du référentiel

Vous pouvez utiliser deux types d’instructions personnalisées de référentiel dans Visual Studio:

  • Instructions personnalisées à l’échelle du référentiel, qui 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 du référentiel.

  • Instructions personnalisées spécifiques à un chemin d’accès, qui s’appliquent aux requêtes effectuées dans le contexte de fichiers correspondant à un chemin d’accès spécifié.

    Ceux-ci sont spécifiés dans un ou plusieurs fichiers NAME.instructions.md dans ou en dessous du répertoire .github/instructions dans le référentiel.

    En utilisant des instructions spécifiques à un chemin d’accès, vous pouvez éviter de surcharger vos instructions à l’échelle du référentiel avec des informations qui ne s’appliquent qu’à certains types de fichiers ou à certains répertoires.

Pour plus d’informations sur le support de ces différents types d’instructions personnalisées de référentiel pour différentes fonctionnalités Copilot, consultez Prise en charge de différents types d’instructions personnalisées.

Pour obtenir une collection organisée d’exemples, consultez Instructions personnalisées.

À propos des fichiers d’invite

Les fichiers d’invite vous permettent de créer et de partager des instructions d’invite réutilisables avec un contexte supplémentaire. Un fichier d’invite est un fichier Markdown, stocké dans votre espace de travail, qui imite le format existant de rédaction des invites dans Copilot Chat (par exemple, Rewrite #file:x.ts). Cela permet de combiner des instructions en langage naturel, du contexte supplémentaire et même des liens vers d’autres fichiers d’invites en tant que dépendances.

Les cas d’utilisation courants sont les suivants :

  • Génération de code. Créez des invites réutilisables pour les composants, les tests ou les migrations (par exemple, les formulaires React ou les simulations d’API).
  • Expertise du domaine. Partagez des connaissances spécialisées à l’aide d’invites, telles que des pratiques de sécurité ou des contrôles de conformité.
  • Collaboration en équipe. Documentez les modèles et les directives en incluant des références aux spécifications et à la documentation.
  • Intégration. Créez des guides pas à pas pour des processus complexes ou des modèles spécifiques à un projet.

Vous pouvez disposer de plusieurs fichiers d’invite dans votre espace de travail, chacun définissant une invite à des fins différentes.

Exemples

Les exemples suivants illustrent l’utilisation des fichiers d’invite.

  • New React form.prompt.md : contient des instructions pour une tâche réutilisable permettant de générer un formulaire à l’aide de React.

    Your goal is to generate a new React form component.
    
    Ask for the form name and fields if not provided.
    
    Requirements for the form:
    - Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
    - Use `react-hook-form` for form state management:
      - Always define TypeScript types for your form data
      - Prefer *uncontrolled* components using register
      - Use `defaultValues` to prevent unnecessary rerenders
    - Use `yup` for validation:
      - Create reusable validation schemas in separate files
      - Use TypeScript types to ensure type safety
      - Customize UX-friendly validation rules
    
  • API security review.prompt.md — contient des informations réutilisables sur les pratiques de sécurité pour les API REST, qui peuvent être utilisées pour effectuer des révisions de sécurité des API REST.

    Secure REST API review:
    - Ensure all endpoints are protected by authentication and authorization
    - Validate all user inputs and sanitize data
    - Implement rate limiting and throttling
    - Implement logging and monitoring for security events
    …
    

Pour plus d’informations sur la création et l’utilisation de fichiers d’invite, consultez Adding repository custom instructions for GitHub Copilot.

Rédiger des instructions personnalisées efficaces

Les instructions que vous ajoutez à votre (vos) fichier(s) d'instructions personnalisé(s) doivent être courtes et autonomes, et fournir à Copilot les informations pertinentes pour l'aider à fonctionner dans ce référentiel. Les instructions étant envoyées avec chaque message de conversation, elles doivent être largement applicables à la plupart des demandes que vous effectuerez dans le contexte du référentiel.

La structure exacte que vous utilisez pour vos fichiers d’instructions varie selon le projet et les besoins, mais les instructions suivantes fournissent un bon point de départ :

  • Fournissez une vue d’ensemble du projet sur lequel vous travaillez, y compris son intention, ses objectifs et toutes les informations contextuelles pertinentes.
  • Indiquez la structure des dossiers du référentiel, y compris les répertoires ou fichiers pertinents pour le projet.
  • Spécifier les normes et conventions de codage à respecter, telles que les conventions de dénomination, les règles de formatage et les meilleures pratiques.
  • Indiquez tous les outils, bibliothèques ou cadres spécifiques utilisés dans le projet, ainsi que les numéros de version ou les configurations correspondantes.

Le fichier d’instructions suivant est un exemple de ces pratiques en 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.

Vous devez également tenir compte de la taille et de la complexité de votre référentiel. Les types d'instructions suivants peuvent fonctionner pour un petit référentiel avec seulement quelques contributeurs, mais pour un référentiel vaste et diversifié, **ils peuvent poser des problèmes ** :

  • Demandes de référence à des ressources externes lors de la formulation d'une réponse
  • Instructions pour répondre dans un style particulier
  • Demande de toujours répondre avec un certain niveau de détail

Par exemple, les instructions suivantes ** peuvent ne pas donner les résultats escomptés ** :

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.

Étapes suivantes

Remarque

Cette version de cet article concerne les instructions personnalisées et les fichiers d’invite dans les IDEs JetBrains. Cliquez sur les onglets ci-dessus pour découvrir d’autres environnements.

À propos de la personnalisation des Copilot réponses

          GitHub Copilot peut fournir des réponses adaptées au fonctionnement de votre équipe, aux outils que vous utilisez ou aux spécificités de votre projet, si vous fournissez suffisamment de contexte pour le faire. Au lieu d’ajouter à plusieurs reprises ces détails contextuels à vos invites, vous pouvez créer un fichier d’instructions personnalisé dans votre référentiel qui ajoute automatiquement ces informations pour vous.

Il existe deux types de fichiers que vous pouvez utiliser pour fournir du contexte et des instructions à Copilot dans les IDE JetBrains :

  • Les instructions personnalisées du référentiel vous permettent de spécifier des instructions et des préférences qui Copilot seront à prendre en compte lors de l’utilisation dans le contexte du référentiel.
  • Les fichiers d’invites (version préliminaire publique) vous permettent d’enregistrer des instructions courantes et le contexte pertinent dans des fichiers Markdown (*.prompt.md) que vous pouvez ensuite réutiliser dans vos invites de chat. Les fichiers d’invite sont disponibles uniquement dans VS Code, Visual Studio, et les IDE JetBrains.

Alors que les instructions personnalisées permettent d’ajouter un contexte à l’échelle du code à chaque flux de travail de l’IA, les fichiers d’invite vous permettent d’ajouter des instructions à une interaction de chat spécifique.

Remarque

En raison de la nature non déterministe de l’IA, Copilot peut ne pas toujours suivre vos instructions personnalisées de la même façon chaque fois qu’elles sont utilisées.

À propos des instructions personnalisées du référentiel

Dans JetBrains IDEs, les instructions personnalisées du référentiel se composent d’un seul fichier, .github/copilot-instructions.md, que vous créez dans un référentiel. Les instructions que vous ajoutez au fichier doivent être des phrases courtes et autonomes, apportant du contexte ou des informations pertinentes pour compléter Copilot une invite.

Prise en charge des instructions personnalisées du référentiel

Pour plus d’informations sur les types d’instructions personnalisées pris en charge dans différents environnements, consultez Prise en charge de différents types d’instructions personnalisées.

Cas d’usage pour les instructions personnalisées

Les cas d’usage courants pour les instructions personnalisées sont les suivants :

  • Génération de tests. Créez des instructions pour la génération de tests, telles que la spécification de l’utilisation d’un certain cadre de test.
  • Révision du code. Précisez les instructions pour la révision du code, par exemple en demandant au réviseur de rechercher une erreur spécifique dans le code.
  • Génération de messages de commit. Rédigez des instructions pour générer des messages de validation, telles que le format ou le type d’informations à inclure.

Exemple

Cet exemple de fichier .github/copilot-instructions.md contient trois instructions pour Copilot.

We use Bazel for managing our Java dependencies, not Maven, so when talking about Java packages, always give me instructions and code samples that use Bazel.

We always write JavaScript with double quotes and tabs for indentation, so when your responses include JavaScript code, please follow those conventions.

Our team uses Jira for tracking items of work.

Pour obtenir une collection organisée d’exemples, consultez Instructions personnalisées.

À propos des fichiers d’invite

Remarque

Les fichiers d’invite sont préversion publique et susceptibles de changer.

Les fichiers d’invite vous permettent de créer et de partager des instructions d’invite réutilisables avec un contexte supplémentaire. Un fichier d’invite est un fichier Markdown, stocké dans votre espace de travail, qui imite le format existant de rédaction des invites dans Copilot Chat (par exemple, Rewrite #file:x.ts). Cela permet de fusionner des instructions en langage naturel et un contexte supplémentaire.

Les cas d’utilisation courants sont les suivants :

  • Génération de code. Créez des invites réutilisables pour les composants, les tests ou les migrations (par exemple, les formulaires React ou les simulations d’API).
  • Expertise du domaine. Partagez des connaissances spécialisées à l’aide d’invites, telles que des pratiques de sécurité ou des contrôles de conformité.
  • Collaboration en équipe. Documentez les modèles et les directives en incluant des références aux spécifications et à la documentation.
  • Intégration. Créez des guides pas à pas pour des processus complexes ou des modèles spécifiques à un projet.

Vous pouvez disposer de plusieurs fichiers d’invite dans votre espace de travail, chacun définissant une invite à des fins différentes.

Exemples

Les exemples suivants illustrent l’utilisation des fichiers d’invite.

  • New React form.prompt.md : contient des instructions pour une tâche réutilisable permettant de générer un formulaire à l’aide de React.

    Your goal is to generate a new React form component.
    
    Ask for the form name and fields if not provided.
    
    Requirements for the form:
    - Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
    - Use `react-hook-form` for form state management:
      - Always define TypeScript types for your form data
      - Prefer *uncontrolled* components using register
      - Use `defaultValues` to prevent unnecessary rerenders
    - Use `yup` for validation:
      - Create reusable validation schemas in separate files
      - Use TypeScript types to ensure type safety
      - Customize UX-friendly validation rules
    
  • API security review.prompt.md — contient des informations réutilisables sur les pratiques de sécurité pour les API REST, qui peuvent être utilisées pour effectuer des révisions de sécurité des API REST.

    Secure REST API review:
    - Ensure all endpoints are protected by authentication and authorization
    - Validate all user inputs and sanitize data
    - Implement rate limiting and throttling
    - Implement logging and monitoring for security events
    …
    

Pour obtenir une collection organisée d’exemples, consultez Fichiers de prompt.

Rédiger des instructions personnalisées efficaces

Les instructions que vous ajoutez à votre (vos) fichier(s) d'instructions personnalisé(s) doivent être courtes et autonomes, et fournir à Copilot les informations pertinentes pour l'aider à fonctionner dans ce référentiel. Les instructions étant envoyées avec chaque message de conversation, elles doivent être largement applicables à la plupart des demandes que vous effectuerez dans le contexte du référentiel.

La structure exacte que vous utilisez pour vos fichiers d’instructions varie selon le projet et les besoins, mais les instructions suivantes fournissent un bon point de départ :

  • Fournissez une vue d’ensemble du projet sur lequel vous travaillez, y compris son intention, ses objectifs et toutes les informations contextuelles pertinentes.
  • Indiquez la structure des dossiers du référentiel, y compris les répertoires ou fichiers pertinents pour le projet.
  • Spécifier les normes et conventions de codage à respecter, telles que les conventions de dénomination, les règles de formatage et les meilleures pratiques.
  • Indiquez tous les outils, bibliothèques ou cadres spécifiques utilisés dans le projet, ainsi que les numéros de version ou les configurations correspondantes.

Le fichier d’instructions suivant est un exemple de ces pratiques en 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.

Vous devez également tenir compte de la taille et de la complexité de votre référentiel. Les types d'instructions suivants peuvent fonctionner pour un petit référentiel avec seulement quelques contributeurs, mais pour un référentiel vaste et diversifié, **ils peuvent poser des problèmes ** :

  • Demandes de référence à des ressources externes lors de la formulation d'une réponse
  • Instructions pour répondre dans un style particulier
  • Demande de toujours répondre avec un certain niveau de détail

Par exemple, les instructions suivantes ** peuvent ne pas donner les résultats escomptés ** :

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.

Étapes suivantes

Remarque

Cette version de l’article concerne les instructions personnalisées dans Xcode. Cliquez sur les onglets ci-dessus pour découvrir d’autres environnements.

À propos de la personnalisation des Copilot réponses

          GitHub Copilot peut fournir des réponses adaptées au fonctionnement de votre équipe, aux outils que vous utilisez ou aux spécificités de votre projet, si vous fournissez suffisamment de contexte pour le faire. Au lieu d’ajouter à plusieurs reprises ces détails contextuels à vos invites, vous pouvez créer un fichier d’instructions personnalisé dans votre référentiel qui ajoute automatiquement ces informations pour vous. Les informations supplémentaires ne s'affichent pas dans la zone de saisie du chat, mais sont disponibles pour Copilot afin de lui permettre de générer des réponses de qualité supérieure.

Remarque

En raison de la nature non déterministe de l’IA, Copilot peut ne pas toujours suivre vos instructions personnalisées de la même façon chaque fois qu’elles sont utilisées.

À propos des instructions personnalisées du référentiel

Dans Xcode, les instructions personnalisées du référentiel se composent d’un fichier unique, .github/copilot-instructions.md, que vous créez dans un référentiel. Les instructions que vous ajoutez au fichier doivent être des phrases courtes et autonomes, apportant du contexte ou des informations pertinentes pour compléter Copilot une invite.

Prise en charge des instructions personnalisées du référentiel

Pour plus d’informations sur les types d’instructions personnalisées pris en charge dans différents environnements, consultez Prise en charge de différents types d’instructions personnalisées.

Cas d’usage pour les instructions personnalisées

Les cas d’usage courants pour les instructions personnalisées du référentiel sont les suivants :

  • Génération de tests. Créez des instructions pour la génération de tests, telles que la spécification de l’utilisation d’un certain cadre de test.
  • Révision du code. Précisez les instructions pour la révision du code, par exemple en demandant au réviseur de rechercher une erreur spécifique dans le code.
  • Génération de messages de commit. Rédigez des instructions pour générer des messages de validation, telles que le format ou le type d’informations à inclure.

Exemple

Cet exemple de fichier .github/copilot-instructions.md contient trois instructions pour Copilot.

We use Bazel for managing our Java dependencies, not Maven, so when talking about Java packages, always give me instructions and code samples that use Bazel.

We always write JavaScript with double quotes and tabs for indentation, so when your responses include JavaScript code, please follow those conventions.

Our team uses Jira for tracking items of work.

Pour obtenir une collection organisée d’exemples, consultez Instructions personnalisées.

Rédiger des instructions personnalisées efficaces

Les instructions que vous ajoutez à votre (vos) fichier(s) d'instructions personnalisé(s) doivent être courtes et autonomes, et fournir à Copilot les informations pertinentes pour l'aider à fonctionner dans ce référentiel. Les instructions étant envoyées avec chaque message de conversation, elles doivent être largement applicables à la plupart des demandes que vous effectuerez dans le contexte du référentiel.

La structure exacte que vous utilisez pour vos fichiers d’instructions varie selon le projet et les besoins, mais les instructions suivantes fournissent un bon point de départ :

  • Fournissez une vue d’ensemble du projet sur lequel vous travaillez, y compris son intention, ses objectifs et toutes les informations contextuelles pertinentes.
  • Indiquez la structure des dossiers du référentiel, y compris les répertoires ou fichiers pertinents pour le projet.
  • Spécifier les normes et conventions de codage à respecter, telles que les conventions de dénomination, les règles de formatage et les meilleures pratiques.
  • Indiquez tous les outils, bibliothèques ou cadres spécifiques utilisés dans le projet, ainsi que les numéros de version ou les configurations correspondantes.

Le fichier d’instructions suivant est un exemple de ces pratiques en 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.

Vous devez également tenir compte de la taille et de la complexité de votre référentiel. Les types d'instructions suivants peuvent fonctionner pour un petit référentiel avec seulement quelques contributeurs, mais pour un référentiel vaste et diversifié, **ils peuvent poser des problèmes ** :

  • Demandes de référence à des ressources externes lors de la formulation d'une réponse
  • Instructions pour répondre dans un style particulier
  • Demande de toujours répondre avec un certain niveau de détail

Par exemple, les instructions suivantes ** peuvent ne pas donner les résultats escomptés ** :

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.

Étapes suivantes

Remarque

Cette version de l’article concerne les instructions personnalisées dans Eclipse. Cliquez sur les onglets ci-dessus pour découvrir d’autres environnements.

À propos de la personnalisation des Copilot réponses

          GitHub Copilot peut fournir des réponses adaptées au fonctionnement de votre équipe, aux outils que vous utilisez ou aux spécificités de votre projet, si vous fournissez suffisamment de contexte pour le faire. Au lieu d’ajouter à plusieurs reprises ces détails contextuels à vos invites, vous pouvez créer un fichier d’instructions personnalisé dans votre référentiel qui ajoute automatiquement ces informations pour vous. Les informations supplémentaires ne s’affichent pas dans la zone de saisie du chat, mais sont à la disposition de Copilot pour lui permettre de générer des réponses de qualité supérieure.

Il existe deux types d’instructions personnalisées de référentiel que vous pouvez utiliser pour fournir un contexte et des instructions à Copilot pour Eclipse :

  • Les instructions personnalisées de l’espace de travail s’appliquent à tous les projets d’un espace de travail et vous permettent de spécifier des instructions et des préférences à l’échelle de l’espace de travail, dans un seul fichier.
  • Instructions personnalisées de projet qui s’appliquent à un projet spécifique.

Remarque

En raison de la nature non déterministe de l’IA, Copilot peut ne pas toujours suivre vos instructions personnalisées de la même façon chaque fois qu’elles sont utilisées.

À propos des instructions personnalisées du référentiel

          **Les instructions personnalisées de l’espace de travail** s’appliquent à tous les projets d’un espace de travail et vous permettent de spécifier des instructions et des préférences à l’échelle de l’espace de travail. Vous pouvez utiliser des instructions personnalisées pour le workspace pour fournir un contexte et des instructions à Copilot dans Eclipse.

          **Project instructions personnalisées** se composent d’un fichier unique, `.github/copilot-instructions.md`, que vous créez dans un projet. Les instructions que vous ajoutez au fichier doivent être des énoncés courts et autonomes qui ajoutent des informations contextuelles ou pertinentes pour compléter une invite Copilot.

Les cas d’utilisation courants sont les suivants :

  • Génération de tests. Créez des instructions pour la génération de tests, telles que la spécification de l’utilisation d’un certain cadre de test.
  • Révision du code. Précisez les instructions pour la révision du code, par exemple en demandant au réviseur de rechercher une erreur spécifique dans le code.
  • Génération de messages de commit. Rédigez des instructions pour générer des messages de validation, telles que le format ou le type d’informations à inclure.

Exemple

Cet exemple de fichier .github/copilot-instructions.md contient trois instructions pour Copilot.

We use Bazel for managing our Java dependencies, not Maven, so when talking about Java packages, always give me instructions and code samples that use Bazel.

We always write JavaScript with double quotes and tabs for indentation, so when your responses include JavaScript code, please follow those conventions.

Our team uses Jira for tracking items of work.

Pour obtenir une collection organisée d’exemples, consultez Instructions personnalisées.

Rédiger des instructions personnalisées efficaces

Les instructions que vous ajoutez à votre (vos) fichier(s) d'instructions personnalisé(s) doivent être courtes et autonomes, et fournir à Copilot les informations pertinentes pour l'aider à fonctionner dans ce référentiel. Les instructions étant envoyées avec chaque message de conversation, elles doivent être largement applicables à la plupart des demandes que vous effectuerez dans le contexte du référentiel.

La structure exacte que vous utilisez pour vos fichiers d’instructions varie selon le projet et les besoins, mais les instructions suivantes fournissent un bon point de départ :

  • Fournissez une vue d’ensemble du projet sur lequel vous travaillez, y compris son intention, ses objectifs et toutes les informations contextuelles pertinentes.
  • Indiquez la structure des dossiers du référentiel, y compris les répertoires ou fichiers pertinents pour le projet.
  • Spécifier les normes et conventions de codage à respecter, telles que les conventions de dénomination, les règles de formatage et les meilleures pratiques.
  • Indiquez tous les outils, bibliothèques ou cadres spécifiques utilisés dans le projet, ainsi que les numéros de version ou les configurations correspondantes.

Le fichier d’instructions suivant est un exemple de ces pratiques en 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.

Vous devez également tenir compte de la taille et de la complexité de votre référentiel. Les types d'instructions suivants peuvent fonctionner pour un petit référentiel avec seulement quelques contributeurs, mais pour un référentiel vaste et diversifié, **ils peuvent poser des problèmes ** :

  • Demandes de référence à des ressources externes lors de la formulation d'une réponse
  • Instructions pour répondre dans un style particulier
  • Demande de toujours répondre avec un certain niveau de détail

Par exemple, les instructions suivantes ** peuvent ne pas donner les résultats escomptés ** :

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.

Étapes suivantes