Skip to main content

Hinzufügen benutzerdefinierter Repositoryanweisungen für GitHub Copilot

Du kannst eine Datei in einem Repository erstellen, die automatisch Informationen zu allen von dir an Copilot Chat gestellten Fragen hinzufügt.

Note

  • Dieses Feature befindet sich aktuell in der public preview und kann noch geändert werden.

  • Im Moment werden benutzerdefinierte Anweisungen für Copilot Chat in Visual Studio, VS Code und auf der GitHub-Website unterstützt.

    Diese Version des Artikels ist für die Verwendung benutzerdefinierter Repositoryanweisungen in Visual Studio vorgesehen. Klicke oben auf die Registerkarten, wenn du Informationen zur Verwendung benutzerdefinierter Anweisungen in anderen Umgebungen möchtest.

Informationen zu benutzerdefinierten Repositoryanweisungen für 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 eine Datei 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.

Voraussetzungen

  • Eine Datei mit benutzerdefinierten Anweisungen – siehe Anweisungen unten

Erstellen einer Datei für benutzerdefinierte Repositoryanweisungen

  1. Erstelle im Stamm deines Repositorys eine Datei mit dem Namen .github/copilot-instructions.md.

    Erstelle das .github-Verzeichnis, wenn es noch nicht vorhanden ist.

  2. Füge der Datei Anweisungen in natürlicher Sprache im Markdownformat hinzu.

    Leerzeichen zwischen Anweisungen werden ignoriert, d. h. die Anweisungen können in einem Absatz und jeweils in einer neuen Zeile oder für bessere Lesbarkeit durch leere Zeilen getrennt geschrieben werden.

Beispielanweisungen

Dieses Beispiel einer .github/copilot-instructions.md-Datei enthält drei Anweisungen, die allen Chatfragen hinzugefügt werden.

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 von effektiven benutzerdefinierten Repositoryanweisungen

Die Anweisungen in der .github/copilot-instructions.md-Datei sollten kurz und eigenständig sein und Kontext oder relevante Informationen liefern, um die Chatfragen der Benutzer zu verbessern.

Die folgenden Arten von Anweisungen funktionieren mit hoher Wahrscheinlichkeit nicht wie gewünscht und können zu Problemen in anderen Bereichen von Copilot führen:

  • 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 haben daher wahrscheinlich nicht das beabsichtigte Ergebnis:

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.

Verwendung benutzerdefinierter Repositoryanweisungen

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.

Screenshot: Popup „References“ mit dunkelorange umrandeter Datei „copilot-instructions.md“

Aktivieren oder Deaktivieren benutzerdefinierter Repositoryanweisungen

Du kannst auswählen, ob deinen Chatfragen benutzerdefinierte Anweisungen hinzugefügt werden sollen.

  1. Klicke auf der Menüleiste von Visual Studio unter Extras auf Optionen.

    Screenshot der Menüleiste von Visual Studio Das Menü „Extras“ wird erweitert, und das Element „Optionen“ ist orangefarben umrissen.

  2. Gib im Dialogfeld „Options“ custom instructions in das Suchfeld ein.

  3. Aktiviere oder deaktiviere das Kontrollkästchen für (Preview) Enable custom instructions to be loaded from .github/copilot-instructions.md files and added to requests.