Informationen zum Anpassen der Antworten von GitHub Copilot Chat

Hinweis

Diese Version dieses Artikels bezieht sich auf benutzerdefinierte Anweisungen auf der GitHub-Website. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.

Hinweis

Diese Version dieses Artikels bezieht sich auf benutzerdefinierte Repositoryanweisungen und Promptdateien in VS Code. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.

Hinweis

Diese Version dieses Artikels bezieht sich auf benutzerdefinierte Anweisungen in Visual Studio. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.

Hinweis

Diese Version dieses Artikels bezieht sich auf benutzerdefinierte Anweisungen in JetBrains-IDEs. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.

Hinweis

Diese Version dieses Artikels bezieht sich auf benutzerdefinierte Anweisungen in Xcode. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.

Hinweis

Diese Version dieses Artikels bezieht sich auf benutzerdefinierte Anweisungen in Eclipse. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.

Informationen zum Anpassen von GitHub Copilot Chat-Antworten

GitHub Copilot kann Chatantworten bereitstellen, die an deine persönlichen Einstellungen, die Arbeitsweise deines Teams, die verwendeten Tools oder die Besonderheiten deines Projekts angepasst sind, wenn du ausreichend Kontext bereitstellst. Anstatt diese Kontextdetails wiederholt zu deinen Chatfragen hinzuzufügen, kannst du benutzerdefinierte Anweisungen erstellen, die diese Informationen automatisch für dich hinzufügen. Diese zusätzlichen Informationen werden nicht im Chat angezeigt, stehen Copilot allerdings zum Generieren besserer Antworten zur Verfügung.

Typen von benutzerdefinierten Anweisungen

Persönliche, benutzerdefinierte Anweisungen gelten für alle Unterhaltungen mit Copilot Chat auf der gesamten GitHub-Website. Sie ermöglichen dir das Angeben deiner individuellen Präferenzen, z. B. den bevorzugten Sprach- oder Antwortstil, um sicherzustellen, dass die Antworten auf deine persönlichen Bedürfnisse zugeschnitten sind.
Benutzerdefinierte Repositoryanweisungen gelten für Unterhaltungen im Kontext eines spezifischen Repositorys. Sie sind nützlich, um projektspezifische Programmierstandards, Frameworks oder Tools zu definieren. Du kannst beispielsweise angeben, dass ein Repository TypeScript und eine bestimmte Bibliothek verwendet, um konsistente Antworten für alle Mitwirkenden zu gewährleisten.
Benutzerdefinierte Anweisungen der Organisation (Public Preview) gelten für Unterhaltungen im Kontext einer Organisation auf der Website GitHub. Sie eignen sich ideal zum Durchsetzen organisationsweiter Einstellungen, z. B. einer gemeinsamen Sprache oder gemeinsamer Sicherheitsrichtlinien. Benutzerdefinierte Anweisungen der Organisation können nur von Organisationsbesitzenden für Organisationen mit Copilot Enterprise-Abonnement festgelegt werden.

Informationen zu benutzerdefinierten Repositoryanweisungen

Du kannst zwei Arten benutzerdefinierter Anweisungen für das Repositry für Copilot Chat auf GitHub.com erstellen:

Repository-wide custom instructions, which apply to all requests made in the context of a repository.

These are specified in a copilot-instructions.md file in the .github directory of the repository.

Repository-wide custom instructions files are used for chat responses, for code review, and also by Copilot-Programmier-Agent.
Path-specific custom instructions, which apply to requests made in the context of files that match a specified path.

These are specified in one or more NAME.instructions.md files within the .github/instructions directory in the repository.

By using path-specific instructions you can avoid overloading your repository-wide instructions with information that only applies to files of certain types, or in certain directories.

Hinweis

Currently, path-specific custom instructions files are only used by Copilot Code Review, Copilot-Programmier-Agent, and Copilot Chat in VS Code.

For more information, see Hinzufügen benutzerdefinierter Repositoryanweisungen für GitHub Copilot.

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 Anweisungen für das Repository kannst du Anweisungen und Einstellungen angeben, die Copilot beim Arbeiten im Kontext des Repositorys berücksichtigt.
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.

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 Kontextdetails wiederholt zu deinen Chatfragen hinzuzufügen, kannst du eine Datei mit benutzerdefinierten Anweisungen in deinem Repository erstellen, die diese Informationen automatisch für dich hinzufügt. Diese zusätzlichen Informationen werden nicht im Chat angezeigt, stehen Copilot allerdings zum Generieren besserer Antworten zur Verfügung.

Es gibt zwei Arten benutzerdefinierter Repositoryanweisungen, die du verwenden kannst, um Kontext und Anweisungen für Copilot Chat in Eclipse bereitzustellen:

Benutzerdefinierte Anweisungen für den Arbeitsbereich gelten für alle Projekte in einem Arbeitsbereich und ermöglichen es dir, arbeitsbereichsweite Anweisungen und Einstellungen in einer einzigen Datei anzugeben.
Benutzerdefinierte Anweisungen für das Projekt gelten für ein bestimmtes Projekt.

Verwenden von benutzerdefinierten Anweisungen

Benutzerdefinierte Anweisungen bestehen aus Anweisungen in natürlicher Sprache und sind am effektivsten, wenn sie kurz und eigenständig sind. Berücksichtige den Bereich, in dem die Anweisung angewendet werden soll, wenn du auswählst, ob eine Anweisung auf persönlicher, Repository- oder (falls verfügbar) Organisationsebene hinzugefügt werden soll.

Hinweis

Multiple types of custom instructions can apply to a Copilot Chat conversation. Personal instructions take the highest priority, followed by repository instructions, with organization instructions prioritized last. However, all sets of relevant instructions are still combined and provided to Copilot Chat.
Whenever possible, you should avoid providing conflicting sets of instructions. If you are concerned about response quality, you can also choose to temporarily disable repository instructions. See Hinzufügen benutzerdefinierter Repositoryanweisungen für GitHub Copilot.

Häufige Anwendungsfälle und Beispiele für alle Typen benutzerdefinierter Anweisungen:

Persönliche, benutzerdefinierte Anweisungen:
- Bevorzugte einzelne Sprache: Always respond in Portuguese.
- Individuelle Antworteinstellungen: Explain a single concept per line. Be clear and concise.
Benutzerdefinierte Repositoryanweisungen:
- Programmierstandards: Use early returns whenever possible.
- Frameworks: Use Vue with the PrimeVue library. oder Use Typescript rather than Javascript.
- Codeformateinstellungen: Use camel case for variable names.
Benutzerdefinierte Anweisungen der Organisation:
- Beschreiben, wie bestimmte Fragen beantwortet werden: For questions related to security, use the Security Docs Knowledge Base or advise people to consult with #security on Slack.
- Bevorzugte Sprache für ein Unternehmen, das ausschließlich eine Sprache spricht: Always respond in Portuguese.
- Organisationsweite Einstellungen: Do not generate code blocks in responses.

Informationen zu benutzerdefinierten Repositoryanweisungen

Du kannst zwei Arten benutzerdefinierter Anweisungen für das Repository zur Verwendung in VS Code erstellen:

Repository-wide custom instructions, which apply to all requests made in the context of a repository.

These are specified in a copilot-instructions.md file in the .github directory of the repository.

Repository-wide custom instructions files are used for chat responses, for code review, and also by Copilot-Programmier-Agent.
Path-specific custom instructions, which apply to requests made in the context of files that match a specified path.

These are specified in one or more NAME.instructions.md files within the .github/instructions directory in the repository.

By using path-specific instructions you can avoid overloading your repository-wide instructions with information that only applies to files of certain types, or in certain directories.

Hinweis

Currently, path-specific custom instructions files are only used by Copilot Code Review, Copilot-Programmier-Agent, and Copilot Chat in VS Code.

For more information, see Hinzufügen benutzerdefinierter Repositoryanweisungen für GitHub Copilot.

Informationen zu Promptdateien

Hinweis

Promptdateien befinden sich in der public preview, und Änderungen sind vorbehalten.

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
…

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 unterstützen.

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. um Bearbeitende anzuweisen, nach einem bestimmten Fehler im Code zu suchen.
Generierung von Commitnachrichten: 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 benutzerdefinierten Repositoryanweisungen

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. um Bearbeitende anzuweisen, nach einem bestimmten Fehler im Code zu suchen.
Generierung von Commitnachrichten: 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.

Informationen zu benutzerdefinierten Repositoryanweisungen

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. um Bearbeitende anzuweisen, nach einem bestimmten Fehler im Code zu suchen.
Generierung von Commitnachrichten: 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.

Informationen zu benutzerdefinierten Repositoryanweisungen

Benutzerdefinierte Anweisungen für den Arbeitsbereich gelten für alle Projekte in einem Arbeitsbereich und ermöglichen es dir, arbeitsbereichsweite Anweisungen und Einstellungen anzugeben. Du kannst benutzerdefinierte Anweisungen für den Arbeitsbereich verwenden, um Kontext und Anweisungen für Copilot Chat in Eclipse bereitzustellen.

Benutzerdefinierte Anweisungen für das Projekt bestehen aus einer einzelnen Datei (.github/copilot-instructions.md), die du in einem Projekt erstellst. Die Anweisungen in der Datei sollten kurz und eigenständig sein und Kontext oder relevante Informationen liefern, um die Chatfragen zu unterstützen.

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. um Bearbeitende anzuweisen, nach einem bestimmten Fehler im Code zu suchen.
Generierung von Commitnachrichten: 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.

Schreiben hilfreicher benutzerdefinierter Anweisungen

Die Anweisungen, die du hinzufügst, sollten idealerweise kurze, eigenständige Anweisungen sein, die relevante und hilfreiche Informationen für Copilot bereitstellen.

Beim Schreiben benutzerdefinierter Anweisungen für ein Repository solltest du auch die Größe und Komplexität deines Repositorys berücksichtigen. Die folgenden Anweisungen können für kleine Repositorys mit nur wenigen Mitwirkenden funktionieren, bei großen und vielfältigen Repositorys jedoch unter Umständen Probleme verursachen:

Anweisungen zum Nutzen externer Ressourcen beim Generieren einer Antwort
Anweisungen zum Antworten in einem bestimmten Stil
Anweisungen, immer mit einem bestimmten Detailniveau zu antworten

Die folgenden Anweisungen z. B. geben möglicherweise nicht die beabsichtigten Ergebnisse zurück:

Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.

Use @terminal when answering questions about Git.

Answer all questions in the style of a friendly colleague, using informal language.

Answer all questions in less than 1000 characters, and words of no more than 12 characters.