Deine ersten benutzerdefinierten Anweisungen

Info zu Anpassungen

Du kannst GitHub Copilot mithilfe von zwei Dateitypen anpassen:

• Benutzerdefinierte Anweisungen bieten einen fortlaufenden Leitfaden für das Verhalten von GitHub Copilot bei allen Interaktionen.
• Promptdateien (Public Preview) definieren wiederverwendbare Prompts für bestimmte Aufgaben, die du bei Bedarf aufrufen kannst. Promptdateien sind nur in VS Code verfügbar. Ein Einführungsbeispiel findest du unter Die erste Promptdatei.

Benutzerdefinierte Anweisungen helfen zwar beim Hinzufügen von Kontext zu den einzelnen KI-Workflows, mit Promptdateien kannst du jedoch Anweisungen zu einer bestimmten Chatinteraktion hinzufügen.

Benutzerdefinierte Repositoryanweisungen werden am häufigsten verwendet und unterstützt. Du kannst jedoch auch persönliche und organisationsspezifische Anweisungen definieren, nur für GitHub Copilot Chat in 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.

Deine ersten Anweisungen

Beginne mit diesen grundlegenden benutzerdefinierten Anweisungen, die GitHub Copilot dabei unterstützen, deine Programmierpräferenzen zu verstehen.

Anweisungen zum Schreiben von Funktionen

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

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

Diese Anweisungen ändern, wie GitHub Copilot Funktionen generiert.

Testen

Um schnell den Unterschied zu testen, den benutzerdefinierte Anweisungen machen können, kannst du persönliche benutzerdefinierte Anweisungen in der immersiven Ansicht von Copilot Chat verwenden.

1. Wechsle zuerst zu github.com/copilot, und gib diesen Prompt ein:

   Create a JavaScript function that calculates the area of a circle

   Ohne benutzerdefinierte Anweisungen kommt möglicherweise Folgendes dabei heraus:

   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. Greife nun auf deine persönlichen benutzerdefinierten Anweisungen zu, indem du unten links auf der Seite auf dein Profilbild und dann auf Personal instructions klickst. Füge die obigen Anweisungen in das Textfeld ein, und klicke dann auf Save.

   Gib nun den gleichen Prompt ein, die du zuvor eingegeben hast.

   Mit benutzerdefinierten Anweisungen erhältst du etwa Folgendes:

   /**
    * 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

• Informationen zum Anpassen der Antworten von GitHub Copilot Chat - Overview of response customization in GitHub Copilot
• Konfigurieren von benutzerdefinierten Anweisungen für GitHub Copilot - How to configure custom instructions
• Awesome GitHub Copilot Customizations - Repository of community-contributed custom instructions and other customizations for specific languages and scenarios