Hinweis
Diese Version dieses Artikels befasst sich mit benutzerdefinierten Anweisungen auf der GitHub Website. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.
Informationen zum Anpassen von Copilot Antworten
GitHub Copilot kann Antworten bereitstellen, die auf Ihre persönlichen Vorlieben zugeschnitten sind, wie Ihr Team funktioniert, welche Tools Sie verwenden, oder die Besonderheiten Ihres Projekts, wenn Sie dies mit genügend Kontext versehen. Anstatt diese kontextbezogenen Details wiederholt zu Ihren Eingabeaufforderungen hinzuzufügen, können Sie benutzerdefinierte Anweisungen erstellen, die diese Informationen automatisch für Sie hinzufügen. Die zusätzlichen Informationen werden nicht angezeigt, stehen aber zur Verfügung, um Copilot es zu ermöglichen, antworten mit höherer Qualität zu generieren.
Hinweis
Aufgrund der nicht-deterministischen Natur von KI befolgen Copilot Ihre benutzerdefinierten Anweisungen möglicherweise nicht immer exakt bei jeder Verwendung.
Typen von benutzerdefinierten Anweisungen
Es gibt drei Haupttypen von benutzerdefinierten Anweisungen, mit denen Sie Antworten auf der Copilot Website anpassen GitHub können:
-
** [Persönliche Anweisungen](#about-personal-instructions)** gelten für alle Unterhaltungen, die Sie auf der GitHub Website über Copilot-Chat führen. 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](#about-repository-custom-instructions)** gelten für Unterhaltungen im Kontext eines bestimmten Repositorys. Sie sind nützlich, um project spezifischen Codierungsstandards, 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](#about-organization-custom-instructions)** gelten für Unterhaltungen im Kontext einer Organisation auf der GitHub Website. Sie eignen sich ideal zum Durchsetzen organisationsweiter Einstellungen, z. B. einer gemeinsamen Sprache oder gemeinsamer Sicherheitsrichtlinien. Angepasste Anweisungen der Organisation können nur von Organisationsbesitzern für Organisationen mit einem Copilot Business oder Copilot Enterprise Abonnement festgelegt werden.
Informationen zu persönlichen Anweisungen
Hinweis
Persönliche benutzerdefinierte Anweisungen werden nur für GitHub Copilot Chat auf GitHub unterstützt.
Sie können anpassen, wie Copilot-Chat auf Sie auf GitHub.com reagiert, indem Sie persönliche Anweisungen hinzufügen, die Copilot nur für Sie gelten. Dies geschieht in einem Popup auf der Copilot-Chat Seite auf GitHub.com. Weitere Informationen findest du unter Hinzufügen von persönlichen benutzerdefinierten Anweisungen für GitHub Copilot.
Informationen zu benutzerdefinierten Repositoryanweisungen
Sie können drei Typen von benutzerdefinierten Repository-Anweisungen in Copilot auf GitHub.com verwenden:
-
**Repositoryweite benutzerdefinierte Anweisungen** gelten für alle Anforderungen, die im Kontext eines Repositorys gestellt werden.Diese werden in einer
copilot-instructions.md-Datei im Verzeichnis.githubdes Repositorys angegeben. -
**Pfadspezifische benutzerdefinierte Anweisungen** gelten für Anforderungen im Kontext von Dateien, die mit einem angegebenen Pfad übereinstimmen.Diese werden in einer oder mehreren
NAME.instructions.mdDateien innerhalb oder unterhalb des.github/instructionsVerzeichnisses im Repository spezifiziert.Mithilfe pfadspezifischer Anweisungen kannst du vermeiden, deine repositoryweiten Anweisungen mit Informationen zu überladen, die ausschließlich für Dateien bestimmter Typen oder in bestimmten Verzeichnissen gelten.
-
**Agent-Anweisungen**, die repositoryweiten benutzerdefinierten Anweisungen ähneln, derzeit jedoch nicht von allen Copilot Funktionen unterstützt werden.Diese werden in Dateien angegeben, die als "
AGENTS.md", "CLAUDE.md" oder "GEMINI.md" bezeichnet werden.
Ausführliche Informationen zur Unterstützung für jede dieser Repositorytypen von benutzerdefinierten Anweisungen in verschiedenen Copilot Features finden Sie unter Unterstützung für verschiedene Arten von benutzerdefinierten Anweisungen.
Eine kuratierte Sammlung von Beispielen finden Sie unter Benutzerdefinierte Anweisungen.
Informationen zu benutzerdefinierten Anweisungen für Organisationen
Hinweis
**Unterstützung:** Benutzerdefinierte Anweisungen für die Organisation werden derzeit nur für Copilot-Chat auf GitHub.com, Copilot Codeüberprüfung auf GitHub.com und Copilot-Cloud-Agent auf GitHub.com unterstützt.
Organisationseigentümer können Anweisungen für Copilot hinzufügen, um Antworten an die Anforderungen und Präferenzen Ihrer Organisation anzupassen. Sie können z. B. auswählen, dass Sie immer Copilot in der gewünschten Sprache Ihres Unternehmens oder mit einem bestimmten Stil antworten möchten.
Benutzerdefinierte Anweisungen, die in den Einstellungen einer Organisation Copilot definiert sind, werden für alle Mitglieder der Organisation verwendet, unabhängig davon, ob sie ihr Copilot Abonnement von dieser Organisation erhalten.
Dies sind einige Beispiele für Anweisungen, die du hinzufügen kannst:
Always respond in Spanish.Do not generate code blocks in responses.For questions related to security, use the Security Docs Knowledge Base.
Rangfolge von benutzerdefinierten Anweisungen
Mehrere Arten von benutzerdefinierten Anweisungen können auf Anforderungen angewendet werden, die an Copilot gesendet werden. Persönliche Anweisungen haben höchste Priorität. Anweisungen für das Repository kommen als Nächstes, und dann werden Organisations-Anweisungen zuletzt priorisiert. Alle Sets mit relevanten Anweisungen werden jedoch Copilot zur Verfügung gestellt.
Die folgende Liste zeigt die vollständige Reihenfolge der Rangfolge mit anweisungen weiter oben in dieser Liste, die Vorrang vor den niedrigeren in der Liste haben:
-
**Persönliche** Anweisungen - Benutzerdefinierte Anweisungen für Repositorys:
*
Path-specific Anweisungen in jeder anwendbaren
.github/instructions/**/*.instructions.mdDatei * Repository-wide Anweisungen in der Datei.github/copilot-instructions.md* Agent-Anweisungen (z. B. in einerAGENTS.mdDatei) -
**Benutzerdefinierte Anweisungen für die Organisation**
Versuchen Sie, wann immer möglich, konfliktende Sätze von Anweisungen zu vermeiden. Wenn Sie sich Sorgen um die Antwortqualität machen, können Sie die Anweisungen im Repository vorübergehend deaktivieren. Weitere Informationen findest du unter Hinzufügen von benutzerdefinierten Repositoryanweisungen für GitHub Copilot.
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ücksichtigen Sie den Bereich, über den die Anweisung angewendet werden soll, wenn Sie auswählen, ob eine Anweisung auf der persönlichen, Repository- oder Organisationsebene hinzugefügt werden soll.
Häufige Anwendungsfälle und Beispiele für alle Typen benutzerdefinierter Anweisungen: * Persönliche Anweisungen:
- Bevorzugte einzelne Sprache:
Always respond in Portuguese. - Individuelle Antworteinstellungen:
Explain a single concept per line. Be clear and concise. -
**Angepasste Repository-Anweisungen:**- Programmierstandards:
Use early returns whenever possible. - Frameworks:
Use Vue with the PrimeVue library.oderUse Typescript rather than Javascript. - Codeformateinstellungen:
Use camel case for variable names.
- Programmierstandards:
-
**Organisation angepasste Anweisungen:**- 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.
- Beschreiben, wie bestimmte Fragen beantwortet werden:
Hinweis
- Copilot Codeüberprüfung liest nur die ersten 4.000 Zeichen einer benutzerdefinierten Anweisungsdatei. Anweisungen, die über diese Grenze hinausgehen, wirken sich nicht auf die von Copilot Codeüberprüfung generierten Bewertungen aus. Dieser Limit gilt nicht für Copilot-Chat oder Copilot-Cloud-Agent.
- Beim Überprüfen eines Pull Requests verwendet Copilot die benutzerdefinierten Anweisungen im Basisbranch des Pull Requests. Wenn Ihr Pull Request beispielsweise darauf abzielt,
my-feature-branchinmainzusammenzuführen, verwendet Copilot die benutzerdefinierten Anweisungen inmain.
Schreiben hilfreicher benutzerdefinierter Anweisungen
Die Anweisungen, die du den Dateien mit benutzerdefinierten Anweisungen hinzufügst, sollten kurze, eigenständige Anweisungen sein, die Copilot zur Unterstützung bei der Arbeit in diesem Repository relevante Informationen bereitstellen. Da die Anweisungen mit jeder Chatnachricht gesendet werden, müssen sie auf die meisten Anforderungen im Zusammenhang mit dem Repository breit anwendbar sein.
Welche Struktur du für die Anweisungsdateien jeweils verwendest, hängt vom Projekt und von den Anforderungen ab. Die folgenden Richtlinien bieten jedoch einen guten Ausgangspunkt:
- Gib einen Überblick über das Projekt, an dem du arbeitest. Dazu gehören der Zweck, die Ziele und alle relevanten Hintergrundinformationen.
- Gib außerdem die Ordnerstruktur des Repositorys an. Dazu gehören alle für das Projekt wichtigen Verzeichnisse oder Dateien.
- Leg die Codierungsstandards und -konventionen fest, die befolgt werden sollen, z. B. Namenskonventionen, Formatierungsregeln und bewährte Methoden.
- Gib alle spezifischen Tools, Bibliotheken oder Frameworks an, die im Projekt verwendet werden, zusammen mit den entsprechenden Versionsnummern oder Konfigurationen.
Die folgende Anweisungendatei ist ein Beispiel für diese Vorgehensweisen in Aktion:
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
Du solltest auch die Größe und Komplexität deines Repositorys berücksichtigen. Die folgenden Arten von Anweisungen können für ein kleines Repository mit nur wenigen Mitwirkenden funktionieren, aber für ein großes und vielfältiges Repository können sie 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 führen möglicherweise nicht zu den gewünschten Ergebnissen:
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.
Nächste Schritte
-
[AUTOTITLE](/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot)
Weiterführende Lektüre
-
[AUTOTITLE](/copilot/concepts/agents/copilot-memory) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)
Hinweis
Diese Version dieses Artikels befasst sich mit benutzerdefinierten Anweisungen und Aufforderungsdateien in VS Code. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.
Informationen zum Anpassen von Copilot Antworten
GitHub Copilot kann Antworten bereitstellen, die auf die Funktionsweise Ihres Teams, die von Ihnen verwendeten Tools oder die Besonderheiten Ihres Projekts zugeschnitten sind, wenn Sie dies mit genügend Kontext bereitstellen. Anstatt diese kontextbezogenen Details wiederholt zu Ihren Eingabeaufforderungen hinzuzufügen, können Sie Dateien in Ihrem Repository erstellen, die diese Informationen automatisch für Sie hinzufügen.
Es gibt zwei Arten von Dateien, die Sie verwenden können, um Kontext und Anweisungen in Copilot bereitzustellen: in VS Code.
-
**Mit benutzerdefinierten Repository-Anweisungen** können Sie Anweisungen und Einstellungen angeben, die Copilot beim Arbeiten im Kontext des Repositories berücksichtigt werden. -
**Prompt-Dateien** (öffentliche Vorschau) bieten dir die Möglichkeit, allgemeine Prompt-Anweisungen und den relevanten Kontext in Markdown-Dateien (`*.prompt.md`) zu speichern, die du dann in deinen Chat-Prompts wiederverwenden kannst. Promptdateien sind nur in VS Code, Visual Studio und JetBrains-IDEs 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.
Hinweis
Aufgrund der nicht-deterministischen Natur von KI befolgen Copilot Ihre benutzerdefinierten Anweisungen möglicherweise nicht immer exakt bei jeder Verwendung.
Informationen zu benutzerdefinierten Repositoryanweisungen
Sie können drei Typen von benutzerdefinierten Repositoryanweisungen verwenden in VS Code:
-
**Repositoryweite benutzerdefinierte Anweisungen** gelten für alle Anforderungen, die im Kontext eines Repositorys gestellt werden.Diese werden in einer
copilot-instructions.md-Datei im Verzeichnis.githubdes Repositorys angegeben. -
**Pfadspezifische benutzerdefinierte Anweisungen** gelten für Anforderungen im Kontext von Dateien, die mit einem angegebenen Pfad übereinstimmen.Diese werden in einer oder mehreren
NAME.instructions.mdDateien innerhalb oder unterhalb des.github/instructionsVerzeichnisses im Repository spezifiziert.Mithilfe pfadspezifischer Anweisungen kannst du vermeiden, deine repositoryweiten Anweisungen mit Informationen zu überladen, die ausschließlich für Dateien bestimmter Typen oder in bestimmten Verzeichnissen gelten.
-
**Agent-Anweisungen**, die repositoryweiten benutzerdefinierten Anweisungen ähneln, derzeit jedoch nicht von allen Copilot Funktionen unterstützt werden.Diese werden in Dateien angegeben, die als "
AGENTS.md", "CLAUDE.md" oder "GEMINI.md" bezeichnet werden.
Ausführliche Informationen zur Unterstützung für jede dieser Repositorytypen von benutzerdefinierten Anweisungen in verschiedenen Copilot Features finden Sie unter Unterstützung für verschiedene Arten von benutzerdefinierten Anweisungen.
Eine kuratierte Sammlung von Beispielen finden Sie unter Benutzerdefinierte Anweisungen.
Informationen zu Promptdateien
Hinweis
Prompt-Dateien sind öffentliche Vorschau und können geändert werden.
Mithilfe von Promptdateien kannst du wiederverwendbare Promptanweisungen mit zusätzlichem Kontext erstellen und freigeben. Eine Schreibaufforderungsdatei ist eine Markdown-Datei, die in Ihrem Arbeitsbereich gespeichert ist und das vorhandene Format für Schreibaufforderungen 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:
-
**Code generieren**. Erstelle wiederverwendbare Prompts für Komponenten, Tests oder Migrationen (z. B. React Forms oder API Mocks). -
**Domänenwissen**. Teile Fachwissen durch Prompts, wie z. B. Sicherheitspraktiken oder Compliance-Checks. -
**Zusammenarbeit im Team**. Dokumentiere Muster und Richtlinien mit Verweisen auf Spezifikationen und Dokumentation. -
**Onboarding**. Erstellen Sie schrittweise 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, um ein Formular mit React zu generieren.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 zum Aktivieren, Erstellen und Verwenden von Eingabeaufforderungsdateien finden Sie unter Hinzufügen von benutzerdefinierten Repositoryanweisungen für GitHub Copilot.
Schreiben hilfreicher benutzerdefinierter Anweisungen
Die Anweisungen, die du den Dateien mit benutzerdefinierten Anweisungen hinzufügst, sollten kurze, eigenständige Anweisungen sein, die Copilot zur Unterstützung bei der Arbeit in diesem Repository relevante Informationen bereitstellen. Da die Anweisungen mit jeder Chatnachricht gesendet werden, müssen sie auf die meisten Anforderungen im Zusammenhang mit dem Repository breit anwendbar sein.
Welche Struktur du für die Anweisungsdateien jeweils verwendest, hängt vom Projekt und von den Anforderungen ab. Die folgenden Richtlinien bieten jedoch einen guten Ausgangspunkt:
- Gib einen Überblick über das Projekt, an dem du arbeitest. Dazu gehören der Zweck, die Ziele und alle relevanten Hintergrundinformationen.
- Gib außerdem die Ordnerstruktur des Repositorys an. Dazu gehören alle für das Projekt wichtigen Verzeichnisse oder Dateien.
- Leg die Codierungsstandards und -konventionen fest, die befolgt werden sollen, z. B. Namenskonventionen, Formatierungsregeln und bewährte Methoden.
- Gib alle spezifischen Tools, Bibliotheken oder Frameworks an, die im Projekt verwendet werden, zusammen mit den entsprechenden Versionsnummern oder Konfigurationen.
Die folgende Anweisungendatei ist ein Beispiel für diese Vorgehensweisen in Aktion:
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
Du solltest auch die Größe und Komplexität deines Repositorys berücksichtigen. Die folgenden Arten von Anweisungen können für ein kleines Repository mit nur wenigen Mitwirkenden funktionieren, aber für ein großes und vielfältiges Repository können sie 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 führen möglicherweise nicht zu den gewünschten Ergebnissen:
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.
Nächste Schritte
-
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/tutorials/use-custom-instructions) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)
Hinweis
Diese Version dieses Artikels befasst sich mit benutzerdefinierten Anweisungen und Aufforderungsdateien in Visual Studio. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.
Informationen zum Anpassen von Copilot Antworten
GitHub Copilot kann Antworten bereitstellen, die auf die Funktionsweise Ihres Teams, die von Ihnen verwendeten Tools oder die Besonderheiten Ihres Projekts zugeschnitten sind, wenn Sie dies mit genügend Kontext bereitstellen. Anstatt diese kontextbezogenen Details wiederholt zu Ihren Eingabeaufforderungen hinzuzufügen, können Sie Dateien in Ihrem Repository erstellen, die diese Informationen automatisch für Sie hinzufügen.
Es gibt zwei Arten von Dateien, die Sie verwenden können, um Kontext und Anweisungen für Copilot in Visual Studio bereitzustellen.
- Mit benutzerdefinierten Repository-Anweisungen können Sie Anweisungen und Präferenzen angeben, die Copilot beim Arbeiten im Kontext des Repositorys berücksichtigt werden.
-
**Mit Aufforderungsdateien** können Sie allgemeine Eingabeaufforderungsanweisungen und relevanten Kontext in Markdown-Dateien (`*.prompt.md`) speichern, die Sie dann in Ihren Chataufforderungen wiederverwenden können. Promptdateien sind nur in VS Code, Visual Studio und JetBrains-IDEs 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.
Hinweis
Aufgrund der nicht-deterministischen Natur von KI befolgen Copilot Ihre benutzerdefinierten Anweisungen möglicherweise nicht immer exakt bei jeder Verwendung.
Informationen zu benutzerdefinierten Repositoryanweisungen
Sie können zwei Arten von benutzerdefinierten Repositoryanweisungen verwenden in Visual Studio:
-
**Repository-weite benutzerdefinierte Anweisungen**, die für alle Anfragen gelten, die im Kontext eines Repositorys gestellt werden.Diese werden in einer
copilot-instructions.md-Datei im Verzeichnis.githubdes Repositorys angegeben. -
**Pfad-spezifische benutzerdefinierte Anweisungen**, die für Anfragen gelten, die im Kontext von Dateien gestellt werden, die einem bestimmten Pfad entsprechen.Diese sind in einer oder mehreren
NAME.instructions.md-Dateien innerhalb oder unterhalb des.github/instructions-Verzeichnisses im Repository angegeben.Mithilfe pfadspezifischer Anweisungen kannst du vermeiden, deine repositoryweiten Anweisungen mit Informationen zu überladen, die ausschließlich für Dateien bestimmter Typen oder in bestimmten Verzeichnissen gelten.
Ausführliche Informationen zur Unterstützung für die verschiedenen Arten benutzerdefinierter Anweisungen für Repositories in unterschiedlichen Copilot Features finden Sie unter Unterstützung für verschiedene Arten von benutzerdefinierten Anweisungen.
Eine kuratierte Sammlung von Beispielen finden Sie unter Benutzerdefinierte Anweisungen.
Informationen zu Promptdateien
Mithilfe von Promptdateien kannst du wiederverwendbare Promptanweisungen mit zusätzlichem Kontext erstellen und freigeben. Eine Promptdatei ist eine Markdown-Datei, die in Ihrem Arbeitsbereich gespeichert ist und das bestehende Format von Schreibaufforderungen in Copilot-Chat imitiert (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:
-
**Code generieren**. Erstelle wiederverwendbare Prompts für Komponenten, Tests oder Migrationen (z. B. React Forms oder API Mocks). -
**Domänenwissen**. Teile Fachwissen durch Prompts, wie z. B. Sicherheitspraktiken oder Compliance-Checks. -
**Zusammenarbeit im Team**. Dokumentiere Muster und Richtlinien mit Verweisen auf Spezifikationen und Dokumentation. -
**Onboarding**. Erstellen Sie schrittweise 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, um ein Formular mit React zu generieren.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 zum Erstellen und Verwenden von Eingabeaufforderungsdateien finden Sie unter Hinzufügen von benutzerdefinierten Repositoryanweisungen für GitHub Copilot.
Schreiben hilfreicher benutzerdefinierter Anweisungen
Die Anweisungen, die du den Dateien mit benutzerdefinierten Anweisungen hinzufügst, sollten kurze, eigenständige Anweisungen sein, die Copilot zur Unterstützung bei der Arbeit in diesem Repository relevante Informationen bereitstellen. Da die Anweisungen mit jeder Chatnachricht gesendet werden, müssen sie auf die meisten Anforderungen im Zusammenhang mit dem Repository breit anwendbar sein.
Welche Struktur du für die Anweisungsdateien jeweils verwendest, hängt vom Projekt und von den Anforderungen ab. Die folgenden Richtlinien bieten jedoch einen guten Ausgangspunkt:
- Gib einen Überblick über das Projekt, an dem du arbeitest. Dazu gehören der Zweck, die Ziele und alle relevanten Hintergrundinformationen.
- Gib außerdem die Ordnerstruktur des Repositorys an. Dazu gehören alle für das Projekt wichtigen Verzeichnisse oder Dateien.
- Leg die Codierungsstandards und -konventionen fest, die befolgt werden sollen, z. B. Namenskonventionen, Formatierungsregeln und bewährte Methoden.
- Gib alle spezifischen Tools, Bibliotheken oder Frameworks an, die im Projekt verwendet werden, zusammen mit den entsprechenden Versionsnummern oder Konfigurationen.
Die folgende Anweisungendatei ist ein Beispiel für diese Vorgehensweisen in Aktion:
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
Du solltest auch die Größe und Komplexität deines Repositorys berücksichtigen. Die folgenden Arten von Anweisungen können für ein kleines Repository mit nur wenigen Mitwirkenden funktionieren, aber für ein großes und vielfältiges Repository können sie 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 führen möglicherweise nicht zu den gewünschten Ergebnissen:
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.
Nächste Schritte
-
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)
Hinweis
Diese Version dieses Artikels befasst sich mit benutzerdefinierten Anweisungen und Aufforderungsdateien in JetBrains-IDEs. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.
Informationen zum Anpassen von Copilot Antworten
GitHub Copilot kann Antworten bereitstellen, die auf die Funktionsweise Ihres Teams, die von Ihnen verwendeten Tools oder die Besonderheiten Ihres Projekts zugeschnitten sind, wenn Sie dies mit genügend Kontext bereitstellen. Anstatt diese kontextbezogenen Details wiederholt zu Ihren Eingabeaufforderungen hinzuzufügen, können Sie eine benutzerdefinierte Anweisungendatei in Ihrem Repository erstellen, die diese Informationen automatisch für Sie hinzufügt.
Es gibt zwei Arten von Dateien, die Sie verwenden können, um Kontext und Anweisungen in Copilot JetBrains-IDEs bereitzustellen:
- Mit benutzerdefinierten Anweisungen für das Repository können Sie Anweisungen und Einstellungen angeben, die Copilot beim Arbeiten im Kontext des Repository berücksichtigt werden.
-
**Prompt-Dateien** (öffentliche Vorschau) bieten dir die Möglichkeit, allgemeine Prompt-Anweisungen und den relevanten Kontext in Markdown-Dateien (`*.prompt.md`) zu speichern, die du dann in deinen Chat-Prompts wiederverwenden kannst. Promptdateien sind nur in VS Code, Visual Studio und JetBrains-IDEs 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.
Hinweis
Aufgrund der nicht-deterministischen Natur von KI befolgen Copilot Ihre benutzerdefinierten Anweisungen möglicherweise nicht immer exakt bei jeder Verwendung.
Informationen zu benutzerdefinierten Repositoryanweisungen
In JetBrains-IDEs bestehen benutzerdefinierte Repositoryanweisungen aus einer einzelnen Datei, .github/copilot-instructions.md, die Sie in einem Repository erstellen. Die Anweisungen, die Sie der Datei hinzufügen, sollten kurze, eigenständige Anweisungen sein, die Kontext oder relevante Informationen hinzufügen, um eine Copilot Eingabeaufforderung zu ergänzen.
Unterstützung für benutzerdefinierte Repositoryanweisungen
Ausführliche Informationen dazu, welche Arten von benutzerdefinierten Anweisungen in verschiedenen Umgebungen unterstützt werden, finden Sie unter Unterstützung für verschiedene Arten von benutzerdefinierten Anweisungen.
Anwendungsfälle für benutzerdefinierte Anweisungen
Häufige Anwendungsfälle für benutzerdefinierte Anweisungen sind:
-
**Testgenerierung.** Erstelle Anweisungen für die Testgenerierung, z. B. das Festlegen der Verwendung eines bestimmten Testframeworks. -
**Code-Prüfung.** Gib Anweisungen zum Überprüfen von Code an, z. B. um Bearbeitende anzuweisen, nach einem bestimmten Fehler im Code zu suchen. -
**Commit Nachricht generieren.** 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.
Eine kuratierte Sammlung von Beispielen finden Sie unter Benutzerdefinierte Anweisungen.
Informationen zu Promptdateien
Hinweis
Promptdateien sind öffentliche Vorschau und können geändert werden.
Mithilfe von Promptdateien kannst du wiederverwendbare Promptanweisungen mit zusätzlichem Kontext erstellen und freigeben. Eine Aufforderungsdatei ist eine Markdown-Datei, die in Ihrem Arbeitsbereich gespeichert ist und das vorhandene Format von Schreibaufforderungen in Copilot-Chat imitiert (z. B. Rewrite #file:x.ts). Dies ermöglicht das Kombinieren von Anweisungen in natürlicher Sprache und zusätzlichem Kontext.
Gängige Anwendungsfälle:
-
**Code generieren**. Erstelle wiederverwendbare Prompts für Komponenten, Tests oder Migrationen (z. B. React Forms oder API Mocks). -
**Domänenwissen**. Teile Fachwissen durch Prompts, wie z. B. Sicherheitspraktiken oder Compliance-Checks. -
**Zusammenarbeit im Team**. Dokumentiere Muster und Richtlinien mit Verweisen auf Spezifikationen und Dokumentation. -
**Onboarding**. Erstellen Sie schrittweise 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, um ein Formular mit React zu generieren.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 …
Eine kuratierte Sammlung von Beispielen finden Sie unter Befehlsdateien.
Schreiben hilfreicher benutzerdefinierter Anweisungen
Die Anweisungen, die du den Dateien mit benutzerdefinierten Anweisungen hinzufügst, sollten kurze, eigenständige Anweisungen sein, die Copilot zur Unterstützung bei der Arbeit in diesem Repository relevante Informationen bereitstellen. Da die Anweisungen mit jeder Chatnachricht gesendet werden, müssen sie auf die meisten Anforderungen im Zusammenhang mit dem Repository breit anwendbar sein.
Welche Struktur du für die Anweisungsdateien jeweils verwendest, hängt vom Projekt und von den Anforderungen ab. Die folgenden Richtlinien bieten jedoch einen guten Ausgangspunkt:
- Gib einen Überblick über das Projekt, an dem du arbeitest. Dazu gehören der Zweck, die Ziele und alle relevanten Hintergrundinformationen.
- Gib außerdem die Ordnerstruktur des Repositorys an. Dazu gehören alle für das Projekt wichtigen Verzeichnisse oder Dateien.
- Leg die Codierungsstandards und -konventionen fest, die befolgt werden sollen, z. B. Namenskonventionen, Formatierungsregeln und bewährte Methoden.
- Gib alle spezifischen Tools, Bibliotheken oder Frameworks an, die im Projekt verwendet werden, zusammen mit den entsprechenden Versionsnummern oder Konfigurationen.
Die folgende Anweisungendatei ist ein Beispiel für diese Vorgehensweisen in Aktion:
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
Du solltest auch die Größe und Komplexität deines Repositorys berücksichtigen. Die folgenden Arten von Anweisungen können für ein kleines Repository mit nur wenigen Mitwirkenden funktionieren, aber für ein großes und vielfältiges Repository können sie 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 führen möglicherweise nicht zu den gewünschten Ergebnissen:
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.
Nächste Schritte
-
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/tutorials/use-custom-instructions) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)
Hinweis
Diese Version dieses Artikels bezieht sich auf benutzerdefinierte Anweisungen in Xcode. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.
Informationen zum Anpassen von Copilot Antworten
GitHub Copilot kann Antworten bereitstellen, die auf die Funktionsweise Ihres Teams, die von Ihnen verwendeten Tools oder die Besonderheiten Ihres Projekts zugeschnitten sind, wenn Sie dies mit genügend Kontext bereitstellen. Anstatt diese kontextbezogenen Details wiederholt zu Ihren Eingabeaufforderungen hinzuzufügen, können Sie eine benutzerdefinierte Anweisungendatei in Ihrem Repository erstellen, die diese Informationen automatisch für Sie hinzufügt. Die zusätzlichen Informationen werden nicht im Chateingabefeld angezeigt, stehen jedoch zur Verfügung, um Copilot es zu ermöglichen, antworten mit höherer Qualität zu generieren.
Hinweis
Aufgrund der nicht-deterministischen Natur von KI befolgen Copilot Ihre benutzerdefinierten Anweisungen möglicherweise nicht immer exakt bei jeder Verwendung.
Informationen zu benutzerdefinierten Repositoryanweisungen
In Xcode bestehen benutzerdefinierte Repositoryanweisungen aus einer einzelnen Datei, .github/copilot-instructions.md, die Sie in einem Repository erstellen. Die Anweisungen, die Sie der Datei hinzufügen, sollten kurze, eigenständige Anweisungen sein, die Kontext oder relevante Informationen hinzufügen, um eine Copilot Eingabeaufforderung zu ergänzen.
Unterstützung für benutzerdefinierte Repositoryanweisungen
Ausführliche Informationen dazu, welche Arten von benutzerdefinierten Anweisungen in verschiedenen Umgebungen unterstützt werden, finden Sie unter Unterstützung für verschiedene Arten von benutzerdefinierten Anweisungen.
Anwendungsfälle für benutzerdefinierte Anweisungen
Zu den gängigen Anwendungsfällen für benutzerdefinierte Repositoryanweisungen gehören:
-
**Testgenerierung.** Erstelle Anweisungen für die Testgenerierung, z. B. das Festlegen der Verwendung eines bestimmten Testframeworks. -
**Code-Prüfung.** Gib Anweisungen zum Überprüfen von Code an, z. B. um Bearbeitende anzuweisen, nach einem bestimmten Fehler im Code zu suchen. -
**Commit Nachricht generieren.** 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.
Eine kuratierte Sammlung von Beispielen finden Sie unter Benutzerdefinierte Anweisungen.
Schreiben hilfreicher benutzerdefinierter Anweisungen
Die Anweisungen, die du den Dateien mit benutzerdefinierten Anweisungen hinzufügst, sollten kurze, eigenständige Anweisungen sein, die Copilot zur Unterstützung bei der Arbeit in diesem Repository relevante Informationen bereitstellen. Da die Anweisungen mit jeder Chatnachricht gesendet werden, müssen sie auf die meisten Anforderungen im Zusammenhang mit dem Repository breit anwendbar sein.
Welche Struktur du für die Anweisungsdateien jeweils verwendest, hängt vom Projekt und von den Anforderungen ab. Die folgenden Richtlinien bieten jedoch einen guten Ausgangspunkt:
- Gib einen Überblick über das Projekt, an dem du arbeitest. Dazu gehören der Zweck, die Ziele und alle relevanten Hintergrundinformationen.
- Gib außerdem die Ordnerstruktur des Repositorys an. Dazu gehören alle für das Projekt wichtigen Verzeichnisse oder Dateien.
- Leg die Codierungsstandards und -konventionen fest, die befolgt werden sollen, z. B. Namenskonventionen, Formatierungsregeln und bewährte Methoden.
- Gib alle spezifischen Tools, Bibliotheken oder Frameworks an, die im Projekt verwendet werden, zusammen mit den entsprechenden Versionsnummern oder Konfigurationen.
Die folgende Anweisungendatei ist ein Beispiel für diese Vorgehensweisen in Aktion:
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
Du solltest auch die Größe und Komplexität deines Repositorys berücksichtigen. Die folgenden Arten von Anweisungen können für ein kleines Repository mit nur wenigen Mitwirkenden funktionieren, aber für ein großes und vielfältiges Repository können sie 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 führen möglicherweise nicht zu den gewünschten Ergebnissen:
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.
Nächste Schritte
-
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/tutorials/use-custom-instructions) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)
Hinweis
Diese Version dieses Artikels bezieht sich auf benutzerdefinierte Anweisungen in Eclipse. Klicke auf die Registerkarten oben, um Informationen zu anderen Umgebungen zu erhalten.
Anpassung von Copilot-Antworten
GitHub Copilot kann Antworten bereitstellen, die auf die Funktionsweise Ihres Teams, die von Ihnen verwendeten Tools oder die Besonderheiten Ihres Projekts zugeschnitten sind, wenn Sie dies mit genügend Kontext bereitstellen. Anstatt diese kontextbezogenen Details wiederholt zu Ihren Eingabeaufforderungen hinzuzufügen, können Sie eine benutzerdefinierte Anweisungendatei in Ihrem Repository erstellen, die diese Informationen automatisch für Sie hinzufügt. Die zusätzlichen Informationen werden nicht im Chateingabefeld angezeigt, stehen jedoch zur Verfügung, um Copilot es zu ermöglichen, antworten mit höherer Qualität zu generieren.
Es gibt zwei Arten von benutzerdefinierten Repositoryanweisungen, die Sie verwenden können, um Kontext und Anweisungen in Copilot Eclipse bereitzustellen:
-
**Angepasste Anweisungen für den Arbeitsbereich**, die für alle Projekte in einem Arbeitsbereich gelten und dir die Möglichkeit bieten, arbeitsbereichsweite Anweisungen und Einstellungen in einer einzigen Datei festzulegen. -
**Benutzerdefinierte Projekthinweise**, die für ein bestimmtes Projekt gelten.
Hinweis
Aufgrund der nicht-deterministischen Natur von KI befolgen Copilot Ihre benutzerdefinierten Anweisungen möglicherweise nicht immer exakt bei jeder Verwendung.
Informationen zu benutzerdefinierten Repositoryanweisungen
**Angepasste Anweisungen für den Arbeitsbereich** gelten für alle Projekte in einem Arbeitsbereich und bieten dir die Möglichkeit, arbeitsbereichsweite Anweisungen und Einstellungen festzulegen. Sie können benutzerdefinierte Arbeitsbereichsanweisungen verwenden, um Kontext und Anweisungen in Copilot Eclipse bereitzustellen.
**Project benutzerdefinierte Anweisungen** bestehen aus einer einzelnen Datei, `.github/copilot-instructions.md`, die Sie in einem project erstellen. Die Anweisungen, die Sie der Datei hinzufügen, sollten kurze, eigenständige Anweisungen sein, die Kontext oder relevante Informationen hinzufügen, um eine Copilot Eingabeaufforderung zu ergänzen.
Gängige Anwendungsfälle:
-
**Testgenerierung.** Erstelle Anweisungen für die Testgenerierung, z. B. das Festlegen der Verwendung eines bestimmten Testframeworks. -
**Code-Prüfung.** Gib Anweisungen zum Überprüfen von Code an, z. B. um Bearbeitende anzuweisen, nach einem bestimmten Fehler im Code zu suchen. -
**Commit Nachricht generieren.** 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.
Eine kuratierte Sammlung von Beispielen finden Sie unter Benutzerdefinierte Anweisungen.
Schreiben hilfreicher benutzerdefinierter Anweisungen
Die Anweisungen, die du den Dateien mit benutzerdefinierten Anweisungen hinzufügst, sollten kurze, eigenständige Anweisungen sein, die Copilot zur Unterstützung bei der Arbeit in diesem Repository relevante Informationen bereitstellen. Da die Anweisungen mit jeder Chatnachricht gesendet werden, müssen sie auf die meisten Anforderungen im Zusammenhang mit dem Repository breit anwendbar sein.
Welche Struktur du für die Anweisungsdateien jeweils verwendest, hängt vom Projekt und von den Anforderungen ab. Die folgenden Richtlinien bieten jedoch einen guten Ausgangspunkt:
- Gib einen Überblick über das Projekt, an dem du arbeitest. Dazu gehören der Zweck, die Ziele und alle relevanten Hintergrundinformationen.
- Gib außerdem die Ordnerstruktur des Repositorys an. Dazu gehören alle für das Projekt wichtigen Verzeichnisse oder Dateien.
- Leg die Codierungsstandards und -konventionen fest, die befolgt werden sollen, z. B. Namenskonventionen, Formatierungsregeln und bewährte Methoden.
- Gib alle spezifischen Tools, Bibliotheken oder Frameworks an, die im Projekt verwendet werden, zusammen mit den entsprechenden Versionsnummern oder Konfigurationen.
Die folgende Anweisungendatei ist ein Beispiel für diese Vorgehensweisen in Aktion:
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
Du solltest auch die Größe und Komplexität deines Repositorys berücksichtigen. Die folgenden Arten von Anweisungen können für ein kleines Repository mit nur wenigen Mitwirkenden funktionieren, aber für ein großes und vielfältiges Repository können sie 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 führen möglicherweise nicht zu den gewünschten Ergebnissen:
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.
Nächste Schritte
-
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/tutorials/use-custom-instructions) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)