Personnaliser les réponses de GitHub Copilot Chat

6 minutes

GitHub Copilot Chat peut générer des réponses et du code qui correspondent à vos pratiques de codage et exigences de projet en fonction du contexte approprié. Au lieu d’ajouter à plusieurs reprises ces informations dans chaque invite de conversation, vous pouvez stocker ce contexte dans les fichiers et l’inclure automatiquement dans chaque demande de conversation.

Il existe trois façons principales de personnaliser les réponses IA dans Visual Studio Code :

Instructions personnalisées : Définissez des instructions courantes pour les tâches telles que la génération de code, l’exécution de révisions de code ou la génération de messages de validation. Celles-ci décrivent comment les tâches doivent être effectuées et peuvent spécifier des pratiques de codage, des technologies préférées, des règles de sécurité ou des formats de message de validation.
Fichiers d’invite : définissez des invites réutilisables pour les tâches courantes. Ces requêtes autonomes décrivent ce qui doit être effectué et peuvent inclure des composants de génération automatique de modèles, effectuer des révisions de code, créer des guides pratiques ou générer des plans d’implémentation.
Modes de conversation personnalisés : définissez le fonctionnement de la conversation, les outils qu’il peut utiliser et la façon dont il interagit avec le codebase. Par exemple, les modes de planification avec un accès en lecture seule, les modes de recherche accédant aux ressources externes ou les modes spécifiques au rôle, comme le développement front-end.

Instructions personnalisées

Les instructions personnalisées vous permettent de décrire les instructions qui obtiennent des réponses correspondant à vos pratiques de codage spécifiques et à votre pile technique. Au lieu d’inclure manuellement ce contexte dans chaque requête de conversation, les instructions personnalisées incorporent automatiquement ces informations à chaque demande de conversation.

Note

Les instructions personnalisées ne sont pas prises en compte pour la saisie semi-automatique du code.

Types d’instructions personnalisées

Visual Studio Code prend en charge trois façons de définir des instructions personnalisées :

Type	Description	Cas d’usage
`.github/copilot-instructions.md`	Fichier Markdown unique dans l’espace de travail, inclus automatiquement dans toutes les demandes, prise en charge inter-éditeur.	Pratiques de codage générales, technologies préférées, exigences à l’échelle du projet.
`.instructions.md files`	Plusieurs fichiers Markdown avec prise en charge des modèles Glob, un espace de travail ou un stockage de profil utilisateur.	Instructions spécifiques à la tâche, contrôle granulaire sur le moment où les instructions s’appliquent.
Paramètres de Visual Studio Code	Instructions dans les paramètres utilisateur/espace de travail pour des scénarios spécifiques.	Génération de code, génération de tests, messages de validation, révisions de code, descriptions de demande de tirage (pull request).

Vous pouvez combiner ces approches, mais éviter les instructions en conflit, car aucun ordre de priorité n’est appliqué.

Exemples d’instructions personnalisées

Instructions générales en matière de codage :

---
applyTo: "**"
---
# Project coding standards

## Naming Conventions
- Use PascalCase for component names, interfaces, and type aliases.
- Use camelCase for variables, functions, and methods.
- Prefix private class members with underscore (_).
- Use ALL_CAPS for constants.

## Error Handling
- Use try/catch blocks for async operations.
- Implement proper error boundaries in React components.
- Always log errors with contextual information.

Instructions TypeScript et React :

---
applyTo: "**/*.ts,**/*.tsx"
---
# TypeScript and React standards

Apply the [general coding guidelines](./general-coding.instructions.md) to all code.

## TypeScript Guidelines
- Use TypeScript for all new code.
- Follow functional programming principles where possible.
- Use interfaces for data structures and type definitions.
- Prefer immutable data (const, readonly).
- Use optional chaining (?.) and nullish coalescing (??) operators.

## React Guidelines
- Use functional components with hooks.
- Follow the React hooks rules (no conditional hooks).
- Use React.FC type for components with children.
- Keep components small and focused.
- Use CSS modules for component styling.

Utiliser le fichier .github/copilot-instructions.md

Stockez des instructions personnalisées dans un .github/copilot-instructions.md fichier à la racine de votre espace de travail pour décrire les pratiques de codage, les technologies préférées et les exigences de projet. Ces instructions s’appliquent uniquement à l’espace de travail et sont automatiquement incluses dans chaque demande de conversation.

Étapes de configuration :

Affectez la valeur github.copilot.chat.codeGeneration.useInstructionFiles à true.
Créez .github/copilot-instructions.md à la racine de l’espace de travail.
Décrivez les instructions à l’aide du langage naturel et du format Markdown.

Note

Ce fichier fonctionne dans Visual Studio Code, Visual Studio et GitHub.com.

Utiliser des fichiers .instructions.md

Créez plusieurs .instructions.md fichiers pour des tâches spécifiques, des langages de programmation, des frameworks ou des types de projet. Celles-ci peuvent être appliquées automatiquement en fonction de modèles de fichier ou attachées manuellement aux invites de conversation.

Emplacements de fichier :

Fichiers d’espace de travail : stockés dans le .github/instructions dossier, disponibles uniquement dans l’espace de travail.
Fichiers utilisateur : stockés dans le profil Visual Studio Code, disponibles dans plusieurs espaces de travail et synchronisés via la synchronisation des paramètres.

Structure de fichiers :

---
description: "Brief description of the instructions file"
applyTo: "**/*.ts,**/*.tsx"  # Glob pattern for automatic application
---
# Instructions content in Markdown format

Créez et utilisez des fichiers d’instructions :

Exécutez Chat: New Instructions File à partir de la palette de commandes.
Choisissez l’espace de travail ou l’emplacement de l’utilisateur.
Entrez les instructions de nom et d’auteur dans Markdown.
Permet Chat: Configure Instructions de modifier les fichiers existants.

Attachement manuel :

En mode Conversation : Ajouter des instructions contextuelles >
Palette de commandes : Chat: Attach Instructions

Application automatique : utiliser des applyTo métadonnées avec des modèles glob (** pour toutes les demandes, des modèles spécifiques pour l’application ciblée)

Spécifier des instructions personnalisées dans les paramètres

Configurez des instructions personnalisées dans les paramètres visual Studio Code pour des scénarios spécifiques :

Scenario	Setting
Génération de code	`github.copilot.chat.codeGeneration.instructions`
Génération de test	`github.copilot.chat.testGeneration.instructions`
Révision du code	`github.copilot.chat.reviewSelection.instructions`
Messages de validation	`github.copilot.chat.commitMessageGeneration.instructions`
Titres/descriptions des PR	`github.copilot.chat.pullRequestDescriptionGeneration.instructions`

Définissez des instructions en tant que fichiers externes de texte ou de référence :

"github.copilot.chat.codeGeneration.instructions": [
  {
    "text": "Always add a comment: 'Generated by Copilot'."
  },
  {
    "text": "In TypeScript always use underscore for private field names."
  },
  {
    "file": "general.instructions.md"
  },
  {
    "file": "db.instructions.md"
  }
]

Meilleures pratiques pour les instructions personnalisées

Gardez les instructions concises : chaque instruction doit être une instruction unique et simple.
Évitez les références externes : ne faites pas référence à des normes ou ressources de codage externes.
Organiser par rubrique : fractionnez les instructions en plusieurs fichiers pour une meilleure organisation.
Activer le partage d’équipe : stocker des instructions dans les fichiers contrôlés par la version pour la collaboration d’équipe.
Utiliser l’application ciblée : tirez parti de applyTo la propriété pour obtenir des instructions spécifiques aux fichiers.
Référencez efficacement : référencez des instructions personnalisées dans les fichiers d’invite pour éviter la duplication.

Summary

Les instructions personnalisées dans GitHub Copilot Chat vous permettent de définir des pratiques de codage, des technologies préférées et des exigences de projet qui sont automatiquement incluses dans chaque demande de conversation. En utilisant .github/copilot-instructions.md des fichiers, .instructions.md des fichiers ou des paramètres Visual Studio Code, vous pouvez vous assurer que les réponses générées par l’IA s’alignent sur vos normes de codage et vos besoins de projet. Cette approche améliore la qualité et la pertinence de l’assistance ia tout en maintenant le contrôle sur le processus de codage.

Commentaires

Cette page a-t-elle été utile ?