Informationen zum Anpassen der Antworten von GitHub Copilot Chat

GitHub Copilot kann Chatantworten liefern, die auf die Arbeitsweise deines Teams, eure Tools oder euer Projekt zugeschnitten sind, wenn du genug Kontext zur Verfügung stellst. Anstatt diese kontextbezogenen Details wiederholt zu deinen Chatfragen hinzuzufügen, kannst du Dateienin deinem Repository erstellen, die diese Informationen automatisch für dich hinzufügt.

Es gibt zwei Arten von Dateien, die du verwenden kannst, um Kontext und Anweisungen für GitHub Copilot Chat in VS Code bereitzustellen:

• Mit benutzerdefinierten Repositoryanweisungen kannst du repositoryweite Anweisungen und Einstellungen in einer einzigen Datei angeben, die für alle Unterhaltungen gelten, die im Kontext des Repositorys gehalten werden.
• Mit Promptdateien (Public Preview) kannst du allgemeine Promptanweisungen und relevanten Kontext in Markdown-Dateien (*.prompt.md) speichern, die du dann in deinen Chataufforderungen wiederverwenden kannst. Promptdateien sind nur in VS Code verfügbar.

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.

Informationen zu benutzerdefinierten Repositoryanweisungen

Benutzerdefinierte Repositoryanweisungen bestehen aus einer einzelnen Datei, .github/copilot-instructions.md, die du in einem Repository erstellst. Die Anweisungen in der Datei sollten kurz und eigenständig sein und Kontext oder relevante Informationen liefern, um die Chatfragen zu verbessern.

Gängige Anwendungsfälle:

• Testgenerierung: Erstelle Anweisungen für die Testgenerierung, z. B. das Festlegen der Verwendung eines bestimmten Testframeworks.
• Code Review: Gib Anweisungen zum Überprüfen von Code an, z. B. die Angabe eines Bearbeiters, nach einem bestimmten Fehler im Code zu suchen.
• Generierung von Commit-Nachrichten: Schreibe Anweisungen zum Generieren von Commitnachrichten, z. B. Format oder Typ der Informationen, die einbezogen werden sollen.

Beispiel

Dieses Beispiel einer .github/copilot-instructions.md-Datei enthält drei Anweisungen für 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.

Beispiele für benutzerdefinierte Anweisungen zum Konfigurieren von Copilot Code Review findest du unter AUTOTITLE-.

Informationen zu Promptdateien

Mithilfe von Promptdateien kannst du wiederverwendbare Promptanweisungen mit zusätzlichem Kontext erstellen und freigeben. Eine Promptdatei ist eine Markdowndatei, die in deinem Arbeitsbereich gespeichert ist und 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.

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

In deinem Arbeitsbereich können mehrere Promptdateien vorhanden sein, die jeweils einen Prompt für einen anderen Zweck definieren.

Beispiele

Die folgenden Beispiele veranschaulichen die Verwendung von Promptdateien.

• New React form.prompt.md: enthält Anweisungen für eine wiederverwendbare Aufgabe zum Generieren eines Formulars mithilfe von 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: enthält wiederverwendbare Informationen zu Sicherheitspraktiken für REST-APIs, die verwendet werden können, um Sicherheitsüberprüfungen von 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
  …
  

• Hinzufügen benutzerdefinierter Repositoryanweisungen für GitHub Copilot