Hinzufügen von benutzerdefinierten Anweisungen für GitHub Copilot

Du kannst eine Datei erstellen, mit der automatisch Informationen zu allen Fragen hinzufügt werden, die du an Copilot Chat richtest.

In diesem Artikel

Note

  • Dieses Feature befindet sich aktuell in public preview. Änderungen sind vorbehalten.
  • Im Moment werden benutzerdefinierte Anweisungen nur für Copilot Chat in VS Code und Visual Studio unterstützt.

Informationen zu benutzerdefinierten Anweisungen für GitHub Copilot

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. Du kannst eine Datei erstellen, mit der Kontextinformationen automatisch hinzugefügt werden, sodass du sie nicht immer wieder in deine Chatfragen einbauen musst. 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

  • Die Optionen Use Instruction Files (VS Code) oder Enable custom instructions (Visual Studio) sind in deinen Einstellungen aktiviert. Weitere Informationen findest du weiter unten im Artikel unter Aktivieren oder Deaktivieren von benutzerdefinierten Anweisungen.

    Note

    Die Einstellung ist in VS Code automatisch aktiviert und in Visual Studio automatisch deaktiviert.

Erstellen einer Datei für benutzerdefinierte Anweisungen

  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 reponses include JavaScript code, please follow those conventions.

Our team uses Jira for tracking items of work.

Schreiben hilfreicher benutzerdefinierter Anweisungen

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.

Verwenden benutzerdefinierter Anweisungen

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 Fragen hinzugefügt, die du in der Ansicht von Copilot Chat oder dem Inline-Chat in VS Code und Visual Studio eingibst.

Benutzerdefinierte Anweisungen werden nicht in der Chat-Ansicht oder dem Inline-Chat angezeigt, doch du kannst in der Referenzliste der Antwort 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 der Copilot Chat-Ansicht in VS Code mit einem Verweis auf die Datei „copilot-instructions.md“.

Aktivieren oder Deaktivieren von benutzerdefinierten Anweisungen

Du kannst auswählen, ob deinen Chatfragen benutzerdefinierte Anweisungen hinzugefügt werden sollen. Wähle dafür die Option für die Copilot-Erweiterung in den Einstellungen aus, oder hebe die Auswahl auf.

In VS Code

  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.

In Visual Studio

  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.