Hinzufügen benutzerdefinierter Repositoryanweisungen für GitHub Copilot

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

Benutzerdefinierte Repositoryanweisungen werden derzeit unterstützt für:

• Copilot Chat in Visual Studio, VS Code und auf der GitHub-Website
• Copilot Code Review

Prerequisites for repository custom instructions

• You must have a custom instructions file (see the instructions below).

• Die Verwendung benutzerdefinierter Anweisungen muss aktiviert sein. Diese Einstellung ist standardmäßig aktiviert. Details findest du unter Aktivieren oder Deaktivieren benutzerdefinierter Repositoryanweisungen weiter unten in diesem Artikel.

Du kannst verschiedene Arten von benutzerdefinierten Repositoryanweisungen für die Verwendung auf GitHub.com erstellen:

• Repositoryweite benutzerdefinierte Anweisungen gelten für alle Anforderungen, die im Kontext eines Repositorys gestellt werden.

  Unterstützt von: Copilot Chat, Copilot-Programmier-Agent und Copilot Code Review.

  Diese werden in einer copilot-instructions.md-Datei im Verzeichnis .github des Repositorys angegeben. Weitere Informationen findest du unter Erstellen repositoryweiter benutzerdefinierter Anweisungen.

• Pfadspezifische benutzerdefinierte Anweisungen gelten für Anforderungen im Kontext von Dateien, die mit einem angegebenen Pfad übereinstimmen.

  Unterstützt von: Copilot-Programmier-Agent und Copilot Code Review.

  Diese werden in mindestens einer NAME.instructions.md-Datei im Verzeichnis .github/instructions des Repositorys angegeben. Weitere Informationen findest du unter Erstellen pfadspezifischer benutzerdefinierter Anweisungen.

  Wenn der von dir angegebene Pfad mit einer Datei übereinstimmt, an der Copilot gerade arbeitet, und eine repositoryweite benutzerdefinierte Anweisungsdatei vorhanden ist, werden die Anweisungen aus beiden Dateien verwendet.

• Agent-Anweisungen werden von KI-Agents verwendet.

  Unterstützt von: Copilot-Programmier-Agent.

  Du kannst mindestens eine AGENTS.md-Datei erstellen, die an einer beliebigen Stelle im Repository gespeichert ist. Wenn Copilot funktioniert, hat die nächste AGENTS.md-Datei in der Verzeichnisstruktur Vorrang.

  Alternativ kannst du eine einzelne CLAUDE.md- oder GEMINI.md-Datei verwenden, die im Stammverzeichnis des Repositorys gespeichert ist.

Erstellen repositoryweiter benutzerdefinierter Anweisungen

Du kannst deine eigene benutzerdefinierte Anleitungsdatei von Grund auf neu erstellen. Weitere Informationen findest du unter Schreiben deiner eigenen „instructions.md“-Datei für Copilot. Alternativ kannst du Copilot-Programmier-Agent bitten, eine für dich zu generieren.

Anweisen von Copilot-Programmier-Agent zum Generieren einer copilot-instructions.md-Datei

1. Navigiere zur Seite „Agents“ bei github.com/copilot/agents.

   Du kannst diese Seite auch erreichen, indem du auf die Schaltfläche neben der Suchleiste auf einer beliebigen Seite auf GitHub klickst und dann auf der Seitenleiste Agents auswählst.

2. Wähle im Dropdownmenü im Promptfeld das Repository aus, für das Copilot benutzerdefinierte Anweisungen generieren soll.

3. Kopiere den folgenden Prompt, und passe ihn bei Bedarf an:

   Markdown

   Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.
   
   You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.
   
   <Goals>
   - Reduce the likelihood of a coding agent pull request getting rejected by the user due to
   generating code that fails the continuous integration build, fails a validation pipeline, or
   having misbehavior.
   - Minimize bash command and build failures.
   - Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools.
   </Goals>
   
   <Limitations>
   - Instructions must be no longer than 2 pages.
   - Instructions must not be task specific.
   </Limitations>
   
   <WhatToAdd>
   
   Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time:
   <HighLevelDetails>
   
   - A summary of what the repository does.
   - High level repository information, such as the size of the repo, the type of the project, the languages, frameworks, or target runtimes in use.
   </HighLevelDetails>
   
   Add information about how to build and validate changes so the agent does not need to search and find it each time.
   <BuildInstructions>
   
   - For each of bootstrap, build, test, run, lint, and any other scripted step, document the sequence of steps to take to run it successfully as well as the versions of any runtime or build tools used.
   - Each command should be validated by running it to ensure that it works correctly as well as any preconditions and postconditions.
   - Try cleaning the repo and environment and running commands in different orders and document errors and and misbehavior observed as well as any steps used to mitigate the problem.
   - Run the tests and document the order of steps required to run the tests.
   - Make a change to the codebase. Document any unexpected build issues as well as the workarounds.
   - Document environment setup steps that seem optional but that you have validated are actually required.
   - Document the time required for commands that failed due to timing out.
   - When you find a sequence of commands that work for a particular purpose, document them in detail.
   - Use language to indicate when something should always be done. For example: "always run npm install before building".
   - Record any validation steps from documentation.
   </BuildInstructions>
   
   List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching.
   <ProjectLayout>
   
   - A description of the major architectural elements of the project, including the relative paths to the main project files, the location
   of configuration files for linting, compilation, testing, and preferences.
   - A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines.
   - Document the steps so that the agent can replicate these itself.
   - Any explicit validation steps that the agent can consider to have further confidence in its changes.
   - Dependencies that aren't obvious from the layout or file structure.
   - Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the
   contents of the README, the contents of any key source files, the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files, such as the one containing the main method.
   </ProjectLayout>
   </WhatToAdd>
   
   <StepsToFollow>
   - Perform a comprehensive inventory of the codebase. Search for and view:
   - README.md, CONTRIBUTING.md, and all other documentation files.
   - Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc.
   - All scripts, particularly those pertaining to build and repo or environment setup.
   - All build and actions pipelines.
   - All project files.
   - All configuration and linting files.
   - For each file:
   - think: are the contents or the existence of the file information that the coding agent will need to implement, build, test, validate, or demo a code change?
   - If yes:
      - Document the command or information in detail.
      - Explicitly indicate which commands work and which do not and the order in which commands should be run.
      - Document any errors encountered as well as the steps taken to workaround them.
   - Document any other steps or information that the agent can use to reduce time spent exploring or trying and failing to run bash commands.
   - Finally, explicitly instruct the agent to trust the instructions and only perform a search if the information in the instructions is incomplete or found to be in error.
   </StepsToFollow>
      - Document any errors encountered as well as the steps taken to work-around them.
   
   

4. Click Send now or press Return.

Copilot will start a new session, which will appear in the list below the prompt box. Copilot will create a draft pull request, write your custom instructions, push them to the branch, then add you as a reviewer when it has finished, triggering a notification.

Writing your own copilot-instructions.md file

1. In the root of your repository, create a file named .github/copilot-instructions.md.

   Create the .github directory if it does not already exist.

2. Add natural language instructions to the file, in Markdown format.

   Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.

Creating path-specific custom instructions

1. Create the .github/instructions directory if it does not already exist.

2. Create one or more NAME.instructions.md files, where NAME indicates the purpose of the instructions. The file name must end with .instructions.md.

3. At the start of the file, create a frontmatter block containing the applyTo keyword. Use glob syntax to specify what files or directories the instructions apply to.

   For example:

   ---
   applyTo: "app/models/**/*.rb"
   ---
   

   You can specify multiple patterns by separating them with commas. For example, to apply the instructions to all TypeScript files in the repository, you could use the following frontmatter block:

   ---
   applyTo: "**/*.ts,**/*.tsx"
   ---
   

   To apply the instructions to all files, use applyTo: "**".

4. Add your custom instructions in natural language, using Markdown format. Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.

In der Vollbildansicht von Copilot Chat (github.com/copilot) kannst du eine Unterhaltung starten, die benutzerdefinierte Repositoryanweisungen verwendet, indem du das Repository hinzufügst, das die Anweisungen enthält.

Wenn benutzerdefinierte Repositoryanweisungen von Copilot Chat verwendet werden, wird die Anweisungsdatei als Verweis für die generierte Antwort hinzugefügt. Um herauszufinden, ob benutzerdefinierte Repositoryanweisungen verwendet wurden, erweitere die Liste der Verweise oben in einer Chatantwort im Chatbereich, und überprüfe, ob die .github/copilot-instructions.md-Datei aufgeführt ist.

Du kannst auf die Referenz klicken, um die Datei zu öffnen.

Aktivieren oder Deaktivieren benutzerdefinierter Repositoryanweisungen

Du kannst auswählen, ob Copilot repositorybasierte benutzerdefinierte Anweisungen verwenden soll.

Aktivieren oder Deaktivieren benutzerdefinierter Anweisungen für Copilot Chat

Benutzerdefinierte Anweisungen sind standardmäßig für Copilot Chat aktiviert, sie können jedoch jederzeit deaktiviert oder erneut aktiviert werden. Dies gilt für deine eigene Verwendung von Copilot Chat und betrifft keine anderen Benutzenden.

1. Führe eine der folgenden Aktionen auf GitHub.com durch:

   • Wechsle zu einem Repository mit einer Datei mit benutzerdefinierten Anweisungen, und öffne den Hilfechat.
   • Wechsle zur immersiven Ansicht von Copilot Chat (github.com/copilot) und füge ein Repository an, das eine Datei mit benutzerdefinierten Anweisungen enthält.

2. Klicke im Chatbereich oben auf die Schaltfläche . Auf der immersiven Seite befindet sich die Schaltfläche oben rechts.

3. Klicke auf Disable custom instructions oder Enable custom instructions.

   Hinweis

   Dir werden diese Optionen nur im Kontext eines Repositorys angezeigt, das eine Datei mit benutzerdefinierten Anweisungen enthält.

Deine Wahl bleibt für alle Repositorys mit einer Datei mit benutzerdefinierten Anweisungen erhalten, bis du sie änderst.

Aktivieren oder Deaktivieren benutzerdefinierter Anweisungen für Copilot Code Review

Benutzerdefinierte Anweisungen sind für Copilot Code Review standardmäßig aktiviert. Du kannst sie aber in den Repositoryeinstellungen auf GitHub.com deaktivieren oder erneut aktivieren. Dies gilt für die Nutzung benutzerdefinierter Anweisungen durch Copilot für alle Reviews, die für dieses Repository durchgeführt werden.

1. Klicke im Abschnitt „Code & automation“ der Randleiste auf Copilot und dann auf Code review.
2. Aktiviere oder deaktiviere die Option „Use custom instructions when reviewing pull requests“ mithilfe der Umschaltfläche.