Hinzufügen benutzerdefinierter Repositoryanweisungen für GitHub Copilot

Darüber hinaus kannst du Promptdateien erstellen. Mit Promptdateien kannst du allgemeine Promptanweisungen und relevanten Kontext in einer Markdowndatei (*.prompt.md) angeben, um diese Informationen in deinen Chatprompts wiederzuverwenden. Promptdateien sind nur in VS Code verfügbar.

• Die Option Use Instruction Files muss in deinen Einstellungen aktiviert sein. Diese Einstellung ist standardmäßig aktiviert. Details findest du unter Aktivieren oder Deaktivieren benutzerdefinierter Repositoryanweisungen weiter unten in diesem Artikel.

Wenn du die .github/copilot-instructions.md-Datei gespeichert hast, können die darin enthaltenen Anweisungen von Copilot Chat genutzt werden. Die vollständigen Anweisungen werden automatisch den Anfragen hinzugefügt, die du in der Copilot Chat-Ansicht oder dem Inlinechat eingibst.

Benutzerdefinierte Anweisungen werden nicht in der Chat-Ansicht oder dem Inlinechat angezeigt. Du kannst jedoch in der Referenzliste einer Antwort in der Chat-Ansicht nachsehen, ob sie von Copilot verwendet werden. Wenn dem Prompt, der an das Modell übermittelt wurde, benutzerdefinierte Anweisungen hinzugefügt wurden, dient die .github/copilot-instructions.md-Datei als Referenz. Du kannst auf die Referenz klicken, um die Datei zu öffnen.

1. Öffne den Einstellungs-Editor mit der Tastenkombination BEFEHL+, (Mac) bzw. STRG+, (Linux/Windows).
2. Geben Sie im Suchfeld als Suchbegriff instruction file ein.
3. Aktiviere oder deaktiviere das Kontrollkästchen für Code Generation: Use Instruction Files.

Informationen zu Promptdateien

Mithilfe von Promptdateien kannst du wiederverwendbare Promptanweisungen mit zusätzlichem Kontext erstellen und freigeben. Eine Promptdatei ist eine Markdowndatei, die das vorhandene Format zum Schreiben von Prompts in Copilot Chat nachahmt (z. B. Rewrite #file:x.ts). Dies ermöglicht das Mischen von Anweisungen in natürlicher Sprache mit zusätzlichem Kontext sowie das Verknüpfen anderer Promptdateien als Abhängigkeiten.

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

Gängige Anwendungsfälle:

• Codegenerierung: Erstellen wiederverwendbarer Prompts für Komponenten, Tests oder Migrationen (z. B. React-Formulare oder API-Modelle).
• Fachkenntnisse: Teilen von speziellem Wissen über Prompts (z. B. Sicherheitspraktiken oder Complianceprüfungen)
• Zusammenarbeit im Team: Dokumentmuster und Richtlinien mit Verweisen auf Spezifikationen und Dokumentationen
• Onboarding. Erstellen ausführlicher Anleitungen für komplexe Prozesse oder projektspezifische Muster

Beispiele für Promptdateien

Die folgenden Beispiele veranschaulichen die Verwendung von Promptdateien.

• react-form.prompt.md: Dokumentieren einer wiederverwendbaren Aufgabe zum Generieren eines Formulars

  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
  

• security-api.prompt.md: Dokumentieren wiederverwendbarer Sicherheitspraktiken für REST-APIs, die verwendet werden können, um Sicherheitsüberprüfungen für REST-APIs durchzuführen

  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
  …
  

Verwenden von Promptdateien

Konfiguriere zum Aktivieren von Promptdateien die VS Code-Einstellung chat.promptFiles. Lege sie auf true fest, oder verwende die { "/path/to/folder": boolean }-Notation, um einen anderen Pfad anzugeben. Relative Pfad werden über die Stammordner deines Arbeitsbereichs aufgelöst, und der Standardwert von .github/prompts wird verwendet, wenn kein anderer Pfad angegeben wird. Ausführlichere Anweisungen findest du unter Einstellungsreferenz für GitHub Copilot in VS Code in der Visual Studio Code-Dokumentation.

1. Erstelle eine .prompt.md-Datei im .github/prompts-Verzeichnis deines Arbeitsbereichs.

2. Schreibe Promptanweisungen mithilfe der Markdown-Formatierung.

   Verweise auf zusätzliche Arbeitsbereichsdateien in Form von Markdown-Links ([index](../index.ts)) oder #file:../index.ts-Verweisen in der Promptdatei. Du kannst auch auf andere .prompt.md-Dateien verweisen.

3. Klicke auf das Symbol zum Anfügen, klicke auf Prompt..., und wähle dann die Promptdatei aus, um sie in Copilot Chat oder Copilot Edits anzufügen.

4. Optional kannst du zusätzliche Kontextdateien anfügen, die für die Aufgabe erforderlich sind.

5. Übermittle den Chatprompt.

   • Übermittle den Prompt bei wiederverwendbaren Aufgaben ohne zusätzliche Anweisungen.
   • Füge zusätzliche Anweisungen hinzu, um mehr Kontext für die Aufgabe bereitzustellen.