Vos premières instructions personnalisées

Créez et testez votre première instruction personnalisée avec cet exemple simple.

Dans cet article

Remarque

  • The examples in this library are intended for inspiration—you are encouraged to adjust them to be more specific to your projects, languages, and team processes.
  • For community-contributed examples of custom instructions for specific languages and scenarios, see the Awesome GitHub Copilot Customizations repository.
  • You can apply custom instructions across different scopes, depending on the platform or IDE where you are creating them. For more information, see "À propos de la personnalisation des réponses de GitHub Copilot Chat."

À propos des personnalisations

Vous pouvez personnaliser les réponses de GitHub Copilot à l’aide de deux types de fichiers :

  • Les instructions personnalisées fournissent des conseils continus sur la manière dont GitHub Copilot doit se comporter dans toutes vos interactions.
  • Les fichiers de prompts (préversion publique) définissent des prompts réutilisables pour des tâches spécifiques que vous pouvez invoquer au besoin. Les fichiers d'invite ne sont disponibles que dans VS Code. Pour obtenir un exemple introductif, consultez Votre premier fichier de prompt.

Bien que les instructions personnalisées aident à ajouter du contexte à chaque flux de travail IA, les fichiers de prompts vous permettent d’ajouter des instructions à une interaction de conversation spécifique.

Les instructions personnalisées du référentiel sont les plus couramment utilisées et prises en charge, mais vous pouvez également définir des instructions personnalisées personnelles et d’organisation, uniquement pour GitHub Copilot Chat dans GitHub. You can create repository custom instructions in two ways:

  • Repository-wide instructions: Create a single copilot-instructions.md file at the repository root that applies to all files in the repository.
  • Path-specific instructions: Create one or more .instructions.md files with an applyTo field that apply only to specific files or directories. Path-specific instructions are currently supported for Copilot Chat in Visual Studio Code and GitHub Copilot coding agent.

Vos premières instructions

Commencez par ces instructions personnalisées de base qui aident GitHub Copilot à comprendre vos préférences en matière de codage.

Instructions pour l’écriture de fonctions

Markdown
When writing functions, always:
- Add descriptive JSDoc comments
- Include input validation
- Use early returns for error conditions
- Add meaningful variable names
- Include at least one example usage in comments

Ces instructions modifieront la façon dont GitHub Copilot génère les fonctions.

Tester

Pour tester rapidement la différence que peuvent apporter les instructions personnalisées, vous pouvez les utiliser dans la vue immersive de Copilot Chat.

  1. Tout d’abord, rendez-vous sur github.com/copilot et entrez ce prompt :

    Create a JavaScript function that calculates the area of a circle

    Sans instructions personnalisées, vous pourriez obtenir :

    function areaOfCircle(radius) {
    if (typeof radius !== 'number' || radius < 0) {
        throw new Error('Radius must be a non-negative number');
    }
    return Math.PI * radius * radius;
}

  2. Accédez maintenant à vos instructions personnalisées en cliquant sur votre photo de profil en bas à gauche de la page, puis cliquez sur Instructions personnelles. Collez les instructions ci-dessus dans la zone de texte, puis cliquez sur Enregistrer.

    Entrez maintenant le même prompt que vous avez entré précédemment.

    Avec des instructions personnalisées, vous obtiendrez quelque chose comme :

    /**
 * Calculates the area of a circle given its radius.
 *
 * @param {number} radius - The radius of the circle. Must be a positive number.
 * @returns {number|null} The area of the circle, or null if the input is invalid.
 *
 * @example
 * // returns 78.53981633974483
 * areaOfCircle(5);
 *
 * @example
 * // returns null (invalid input)
 * areaOfCircle(-2);
 */
function areaOfCircle(radius) {
  if (typeof radius !== "number" || isNaN(radius) || radius <= 0) {
    // Invalid input: radius must be a positive number
    return null;
  }

  const area = Math.PI * Math.pow(radius, 2);
  return area;
}

// Example usage:
console.log(areaOfCircle(5));   // 78.53981633974483
console.log(areaOfCircle(-2));  // null

Further reading