Verwendung von GitHub Copilot zur Codeüberprüfung

Erfahren Sie, wie Sie ein Code-Review von GitHub Copilot anfordern.

Tool navigation

In diesem Artikel

Einführung

GitHub Copilot kann Ihren Code überprüfen und Feedback geben. Wenn möglich, Copilotenthält das Feedback vorgeschlagene Änderungen, die Sie mit ein paar Klicks anwenden können.

Eine vollständige Einführung in GitHub Copilot Codeüberprüfung finden Sie in Informationen zur GitHub Copilot Code-Review.

Copilot Codeüberprüfung ist auch für Organisationsmitglieder ohne Copilot Lizenz verfügbar, wenn sie von einem Unternehmensadministrator oder Organisationsbesitzer aktiviert werden. Siehe Copilot Codeüberprüfung zu Organisationsmitgliedern ohne Copilot Lizenz.

Verwenden von Copilot Codeüberprüfung

Diese Anweisungen erläutern die Verwendung Copilot Codeüberprüfung auf der GitHub Website. Um Anweisungen für andere beliebte Programmierumgebungen anzuzeigen, klicke oben auf der Seite auf die entsprechende Registerkarte.

  1. Erstellen Sie auf GitHub.com eine Pullanforderung oder navigieren Sie zu einer vorhandenen Pullanforderung.

  2. Klicken Sie unter „Prüfer“ in der rechten Seitenleiste neben Copilot auf Anfordern.

    Screenshot von Copilot mit der Schaltfläche „Anfordern“ unter „Prüfer“.

  3. Warten Sie, bis Copilot Ihren Pull-Request überprüft. Das dauert in der Regel weniger als 30 Sekunden.

  4. Scrollen Sie nach unten, und lesen Sie die CopilotKommentare.

    Screenshot einer Code-Review von Copilot.

Copilot hinterlässt immer eine "Kommentar"-Bewertung, keine "Genehmigen"-Bewertung oder "Änderungen anfordern"-Bewertung. Dies bedeutet, dass die Überprüfungen von Copilot nicht zu den notwendigen Genehmigungen für die Pull-Anfrage beitragen und die Überprüfungen von Copilot das Zusammenführen von Änderungen nicht blockieren werden. Ausführlichere Informationen findest du unter Einen Pull Request mit erforderlichen Reviews genehmigen.

  1. Copilot's Überprüfungskommentare verhalten sich wie menschliche Überprüfungskommentare. Du kannst ihnen Reaktionen hinzufügen und sie kommentieren, beheben und ausblenden.

    Alle Kommentare, die Sie zu den Überprüfungskommentaren von Copilot hinzufügen, sind für Menschen sichtbar, aber sie sind nicht sichtbar für Copilot, und Copilot wird nicht antworten.

Sie können auch eine Überprüfung von Copilot über die GitHub-REST-API anfordern, indem Sie copilot-pull-request-reviewer[bot] als Prüfer anfordern. Weitere Informationen finden Sie unter REST-API-Endpunkte für Überprüfungsanforderungen.

Aktivieren automatischer Reviews

Standardmäßig fordern Sie bei jedem Pull-Request manuell eine Überprüfung von Copilot an, genauso wie Sie eine Überprüfung von einem Menschen anfordern würden. Sie können jedoch so einrichten Copilot , dass alle Pullanforderungen automatisch überprüft werden. Weitere Informationen findest du unter Konfigurieren der automatischen Codeüberprüfung durch GitHub Copilot.

Arbeiten mit vorgeschlagenen Änderungen, die von Copilot bereitgestellt wurden

Wenn möglich, Copilotenthält das Feedback vorgeschlagene Änderungen, die Sie mit ein paar Klicks anwenden können.

Wenn Sie mit den Änderungen zufrieden sind, können Sie einen einzelnen Vorschlag von Copilot akzeptieren und ihn committen oder eine Gruppe von Vorschlägen in einem einzigen Commit akzeptieren. Weitere Informationen finden Sie unter Feedback in Deinen Pull Request aufnehmen.

Sie können auch aufrufen Copilot-Cloud-Agent , um vorgeschlagene Änderungen zu implementieren. Dafür müssen Sie:

  • Aktivieren GitHub Copilot Codeüberprüfung und Copilot-Cloud-Agent.
  • Klicken Sie bei Prüfkommentaren von GitHub Copilot Codeüberprüfung auf Mit Copilot beheben. Dadurch wird ein Entwurfskommentar für die Pullanforderung erstellt, über den Sie Copilot anweisen können, bestimmtes Feedback zu behandeln. Anschließend können Sie auswählen, ob Copilot einen neuen Pull Request für Ihren Branch erstellen oder einen Commit zum selben Pull Request mit den übernommenen Vorschlägen hinzufügen soll.

Erneute Überprüfung anfordern von Copilot

Wenn Sie Änderungen an eine überprüfte Pull-Anforderung Copilot übertragen, werden Ihre Änderungen nicht automatisch erneut überprüft, es sei denn, Sie haben sie so konfiguriert, dass neue Pushs überprüft werden, nachdem Sie automatische Rezensionen aktiviert haben.

Wenn Sie manuell eine erneute Überprüfung von Copilot anfordern möchten, klicken Sie im Menü Prüfer auf die Schaltfläche neben dem Namen von Copilot. Weitere Informationen finden Sie unter Eine Überprüfung der Pull-Anfrage anfordern.

Um bei jedem Push automatisch erneute Überprüfungen von Copilot anzufordern, aktivieren Sie die automatische Codeüberprüfung für das Repository und wählen Sie in den Regelsatzeinstellungen Neue Pushes überprüfen aus. Weitere Informationen finden Sie unter Konfigurieren der automatischen Codeüberprüfung durch GitHub Copilot.

Hinweis

Beim erneuten Überprüfen einer Pull-Anforderung Copilot können dieselben Kommentare wiederholt werden, auch wenn sie über die Schaltfläche „Unterhaltung auflösen” als erledigt markiert oder mit dem Symbol „Daumen runter (👎)” abgelehnt wurden.

Anpassen von Copilot Bewertungen mit benutzerdefinierten Anweisungen

Du kannst Copilot Codeüberprüfung anpassen, indem du deinem Repository benutzerdefinierte Anweisungen hinzufügst.

Benutzerdefinierte Repository-Anweisungen können repository-weit oder pfadspezifisch sein. Gib repositoryweite benutzerdefinierte Anweisungen in einer .github/copilot-instructions.md-Datei in deinem Repository an. Du kannst diese Datei verwenden, um Informationen zu speichern, die Copilot berücksichtigen sollen, wenn du Code an einer beliebigen Stelle im Repository überprüfst.

Du kannst außerdem Anweisungen schreiben, die Copilot ausschließlich beim Überprüfen von Code in Dateien verwendet, die einem angegebenen Pfad entsprechen. Schreibe diese Anweisungen in mindestens eine .github/instructions/**/*.instructions.md-Datei.

Weitere Informationen finden Sie unter Hinzufügen von benutzerdefinierten Repositoryanweisungen für GitHub Copilot.

Hinweis

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-branch in main zusammenzuführen, verwendet Copilot die benutzerdefinierten Anweisungen in main.

Beispiel

Dieses Beispiel einer .github/copilot-instructions.md-Datei enthält drei Anweisungen, die auf alle Copilot Codeüberprüfung im Repository angewendet werden.

When performing a code review, respond in Spanish.

When performing a code review, apply the checks in the `/security/security-checklist.md` file.

When performing a code review, focus on readability and avoid nested ternary operators.

MCP-Server und Agent-Fähigkeiten

Hinweis

Support for agent skills and MCP servers with Copilot Codeüberprüfung is in Öffentliche Vorschau and subject to change.

Copilot Codeüberprüfung kann Agent-Fähigkeiten und MCP-Server verwenden, die im Repository konfiguriert sind, wenn sie für den zu überprüfenden Code relevant sind.

Um diese für Copilot Codeüberprüfung auf GitHub verfügbar zu machen, konfigurieren Sie:

  • Agent-Fähigkeiten in Ihrem Repository (in .github/skills). Wenn Sie möchten, dass eine Fähigkeit auf Prüfaufgaben abzielt, verwenden Sie einen prüfungsorientierten Namen für das Skillverzeichnis, z. B. code-review. Details zum Setup finden Sie unter Hinzufügen von Agent-Fähigkeiten für GitHub Copilot.
  • MCP-Server in den Copilot-Einstellungen des Repositorys. Der GitHub MCP-Server und der Playwright MCP-Server sind standardmäßig aktiviert. Details zum Setup finden Sie unter Konfigurieren von MCP-Servern für Ihr Repository.

Copilot Codeüberprüfung ist wahrscheinlicher, dass dieser Kontext verwendet wird, wenn:

  • Agent-Kompetenzverzeichnisse verfügen über überprüfungsorientierte Namen und Beschreibungen, z code-review. B. die angeben, dass sie für die Pull-Anforderungsüberprüfung vorgesehen sind.
  • Ihre Agent-Fähigkeiten oder benutzerdefinierte Anweisungen weisen Copilot Codeüberprüfung explizit an, bestimmten MCP-Kontext zu verwenden.
  • Pull-Anforderungsbeschreibungen verweisen auf Elemente, die über konfigurierte MCP-Server verfügbar sind, z. B. Problemschlüssel oder Vorfall-IDs.

Um zu überprüfen, welcher MCP-Kontext Copilot Codeüberprüfung für eine bestimmte Überprüfung verwendet wird, öffnen Sie die verknüpfte Überprüfungssitzung über die Zeitachse der Pull-Anforderung, und überprüfen Sie dann die Sitzungsprotokolle, um festzustellen, welche MCP-Server und -Tools aufgerufen wurden.

In den Repositoryeinstellungen ist Copilot darf bei der Überprüfung von Pull Requests MCP-Tools verwenden standardmäßig aktiviert. Deaktivieren Sie diese Einstellung, wenn Sie möchten, dass MCP-Server nur für Copilot-Cloud-Agent verfügbar sind und nicht für Copilot Codeüberprüfung. Schrittweise Anleitungen finden Sie unter Konfigurieren von MCP-Servern für Ihr Repository.

Bereitstellen von Feedback zu den CopilotRezensionen

Sie können Feedback zu den Kommentaren von Copilot direkt in jedem Kommentar geben. Wir verwenden diese Informationen, um das Produkt und die Qualität der Vorschläge von Copilot zu verbessern.

Wenn Sie Feedback zu einem Bewertungskommentar von Copilot geben möchten, klicken Sie auf die Schaltfläche „Daumen hoch“ (👍) oder „Daumen runter“ (👎).

Screenshot mit einem Copilot Codeüberprüfung Kommentar und den Schaltflächen „Daumen hoch“ und „Daumen runter“.

Überprüfen einer Auswahl an Code

Sie können eine anfängliche Überprüfung einer hervorgehobenen Codeauswahl anfordern in Visual Studio Code.

  1. Wählen Sie in Visual Studio Code, den Code aus, den Sie überprüfen möchten.
  2. Klicken Sie mit der rechten Maustaste auf den ausgewählten Code, und wählen Sie Code generierenÜberprüfung aus.
  3. VS Code erstellt Im Kommentarbereich Rezensionskommentare und zeigt sie auch inline im Editor an.

Überprüfen aller nicht committeten Änderungen

Sie können eine Überprüfung Ihrer nicht abgeschlossenen Änderungen in Visual Studio Codeanfordern.

  1. VS CodeKlicken Sie in der Aktivitätsleiste auf die Schaltfläche "Quellcodeverwaltung".

  2. Zeigen Sie oben in der Ansicht Quellcodeverwaltung mit dem Mauszeiger auf ÄNDERUNGEN, und klicken Sie dann auf die Schaltfläche CopilotCodeüberprüfung – Änderungen ohne Commit.

    Screenshot der Ansicht „Source Control“ Die Schaltfläche „Code Review“ ist dunkelorange umrandet.

  3. Warten Sie, bis Copilot Ihre Änderungen überprüft. Das dauert in der Regel weniger als 30 Sekunden.

  4. Wenn Copilot Kommentare enthält, werden sie inline in Ihren Dateien und auf der Registerkarte Probleme angezeigt.

Arbeiten mit vorgeschlagenen Änderungen, die von Copilot bereitgestellt wurden

Wenn möglich, Copilotenthält das Feedback vorgeschlagene Änderungen, die Sie mit einem einzigen Klick anwenden können.

Screenshot eines Kommentars von Copilot in Visual Studio Code mit einer vorgeschlagenen Änderung

Wenn Sie mit der Änderung zufrieden sind, können Sie einen Vorschlag von Copilot übernehmen, indem Sie die Schaltfläche Übernehmen und Weiter anklicken. Alle von dir angewendeten Änderungen werden nicht automatisch übernommen.

Wenn Sie die von Copilot vorgeschlagene Änderung nicht anwenden möchten, klicken Sie auf die Schaltfläche „Verwerfen und Weiter“.

Bereitstellen von Feedback zu den CopilotRezensionen

Sie können Feedback zu den Kommentaren von Copilot direkt in jedem Kommentar geben. Wir verwenden diese Informationen, um das Produkt und die Qualität der Vorschläge von Copilot zu verbessern.

Um Feedback zu geben, zeige mit der Maus auf den Kommentar, und klicke auf die Schaltfläche „Daumen nach oben“ oder „Daumen nach unten“.

Screenshot eines Kommentars von Copilot in Visual Studio Code mit den angezeigten Feedbackschaltflächen Die Schaltflächen sind dunkelorange umrandet.

Anpassen von Copilot Bewertungen mit benutzerdefinierten Anweisungen

Du kannst Copilot Codeüberprüfung anpassen, indem du deinem Repository benutzerdefinierte Anweisungen hinzufügst.

Benutzerdefinierte Repository-Anweisungen können repository-weit oder pfadspezifisch sein. Gib repositoryweite benutzerdefinierte Anweisungen in einer .github/copilot-instructions.md-Datei in deinem Repository an. Du kannst diese Datei verwenden, um Informationen zu speichern, die Copilot berücksichtigen sollen, wenn du Code an einer beliebigen Stelle im Repository überprüfst.

Du kannst außerdem Anweisungen schreiben, die Copilot ausschließlich beim Überprüfen von Code in Dateien verwendet, die einem angegebenen Pfad entsprechen. Schreibe diese Anweisungen in mindestens eine .github/instructions/**/*.instructions.md-Datei.

Weitere Informationen finden Sie unter Hinzufügen von benutzerdefinierten Repositoryanweisungen für GitHub Copilot.

Hinweis

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-branch in main zusammenzuführen, verwendet Copilot die benutzerdefinierten Anweisungen in main.

Beispiel

Dieses Beispiel einer .github/copilot-instructions.md-Datei enthält drei Anweisungen, die auf alle Copilot Codeüberprüfung im Repository angewendet werden.

When performing a code review, respond in Spanish.

When performing a code review, apply the checks in the `/security/security-checklist.md` file.

When performing a code review, focus on readability and avoid nested ternary operators.

Voraussetzung

Zur Verwendung von Copilot Codeüberprüfung müssen Sie Visual Studio Version 17.14 oder höher verwenden. Weitere Informationen finden Sie auf derVisual Studio Downloadseite.

Verwenden von Copilot Codeüberprüfung

In diesen Anweisungen wird die Verwendung Copilot Codeüberprüfung in Visual Studioerläutert. Um Anweisungen für andere beliebte Programmierumgebungen anzuzeigen, klicke oben auf der Seite auf die entsprechende Registerkarte.

  1. Klicken Sie im Fenster "Git-Änderungen" auf "Änderungen überprüfen" mit Copilot. Diese Schaltfläche wird als Kommentarsymbol mit einem Funkelzeichen angezeigt.

  2. Copilot beginnt mit der Überprüfung Ihrer Änderungen. Nach einigen Momenten wird ein Link mit der Anzahl der Reviewkommentare im Fenster „Git Changes“ angezeigt.

  3. Klicke auf den Link, um die Kommentare anzuzeigen und durchzugehen. Wenn keine Probleme gefunden werden, wird die Meldung angezeigt: Copilot Es wurden keine Dateien kommentiert.

  4. Copilot zeigt Kommentare in Ihrem Code mit einer Zusammenfassung der einzelnen potenziellen Probleme an. Sie können:

    • Überprüfe diese und nimm Änderungen basierend auf den Vorschlägen vor.
    • Schließe einen Kommentar mithilfe des Abwärtspfeils in der oberen rechten Ecke des Kommentarfelds.

  5. Um alle Rezensionskommentare zu entfernen, klicken Sie neben dem Link zur Codeüberprüfung im Git-Fenster "Änderungen".

Weitere Informationen zum Aktivieren und Konfigurieren Copilot Codeüberprüfung in Visual Studiofinden Sie unter "Überprüfen lokaler Änderungen mit Copilot-Chat " in der Visual Studio Dokumentation.

Verwenden von Copilot Codeüberprüfung

In diesen Anweisungen wird die Verwendung Copilot Codeüberprüfung in GitHub Mobileerläutert. Um Anweisungen für andere beliebte Programmierumgebungen anzuzeigen, klicke oben auf der Seite auf die entsprechende Registerkarte.

  1. Öffnen Sie in GitHub Mobile einen Pull-Request.
  2. Scrolle nach unten zum Abschnitt Reviews, und erweitere ihn.
  3. Klicke auf Request Reviews.
  4. Fügen Sie Copilot als Prüfer hinzu, und klicken Sie dann auf Fertig.

Copilot überprüft die Änderungen und gibt Feedback.

Voraussetzung

Um in Xcode zu verwenden Copilot Codeüberprüfung , müssen Sie Version 0.41.0 oder höher der GitHub Copilot Gespräch Erweiterung verwenden. Laden Sie die neueste Version aus dem Repository github/CopilotForXcode herunter.

Verwenden von Copilot Codeüberprüfung

In diesen Anweisungen wird die Verwendung Copilot Codeüberprüfung in Xcode erläutert. Um Anweisungen für andere beliebte Programmierumgebungen anzuzeigen, klicke oben auf der Seite auf die entsprechende Registerkarte.

  1. Nimm in Xcode einige Änderungen an einer oder mehreren Dateien vor.

  2. Öffnen Sie das Copilot Chatfenster, indem Sie in der Menüleiste auf "Editor" klicken und dann auf "GitHub Copilot klicken********.

  3. Klicken Sie unten rechts im Eingabeaufforderungsfeld im Copilot Chatfenster auf die Schaltfläche " Codeüberprüfung " (ein Sprachblasensymbol).

    Screenshot: Chatfenster von Copilot in Xcode mit dunkelorange umrandeter Schaltfläche „Code Review“

  4. Klicke auf Review Staged Changes oder Review Unstaged Changes.

  5. Eine Liste mit Dateien, die Änderungen enthalten, wird im Chatfenster angezeigt. Klicken Sie auf die Kontrollkästchen, um die Auswahl aller Dateien aufzuheben, die Sie nicht überprüfen möchten Copilot .

  6. Klicke auf Continue, um den Reviewprozess zu starten.

  7. Wenn Copilot Dinge findet, auf die es kommentieren kann, wird im Chatfenster eine Liste von Überprüfte Änderungen angezeigt, in der die Dateien aufgelistet werden, die kommentiert wurden. Klicke in dieser Liste auf eine Datei, um die Kommentare anzuzeigen.

    Jeder Kommentar wird in einem überlagerten Popup über dem Editor angezeigt.

    Screenshot eines Reviewkommentars von Copilot Codeüberprüfung.

  8. Falls die Datei mehrere Kommentare enthält, kannst du mit den Auf- und Abwärtspfeilen oben rechts im Popup zwischen Kommentaren navigieren.

  9. Copilot kann Ersatzcode vorschlagen. Du kannst die vorgeschlagene Änderung anwenden, indem du auf Accept klickst, oder ablehnen, indem du auf Dismiss klickst.

  10. Klicke im Chatfenster auf eine andere Datei in der Liste Reviewed Changes, um die Reviewkommentare für eine andere Datei anzuzeigen.

Voraussetzungen

  • Zugriff auf Copilot. Weitere Informationen findest du unter Was ist GitHub Copilot?.

  • Kompatible JetBrains-IDE. Für die Verwendung GitHub Copilot in JetBrains muss eine kompatible JetBrains-IDE installiert sein. GitHub Copilot ist mit den folgenden IDEs kompatibel:

    • IntelliJ IDEA (Ultimate, Community, Educational)
    • Android Studio
    • CLion
    • Code With Me (Gast)
    • DataGrip
    • DataSpell
    • GoLand
    • JetBrains-Client
    • MPS
    • PhpStorm
    • PyCharm (Professional, Community, Educational)
    • Rider
    • RubyMine
    • RostRover
    • WebStorm

    Informationen zum Herunterladen findest du im JetBrains-IDEs-Tool-Finder.

  • Neueste Version der GitHub Copilot Erweiterung. Sehen Sie sich das GitHub Copilot Plug-In im JetBrains Marketplace an. Anweisungen zum Installieren findest du unter Installieren der GitHub Copilot-Erweiterung in Ihrer Umgebung.

  • Melden Sie sich bei Ihrer JetBrains-IDE anGitHub. Anweisungen zum Authentifizieren findest du unter Installieren der GitHub Copilot-Erweiterung in Ihrer Umgebung.

Verwenden von Copilot Codeüberprüfung

In diesen Anweisungen wird die Verwendung Copilot Codeüberprüfung in JetBrains-IDEs erläutert. Um Anweisungen für andere beliebte Programmierumgebungen anzuzeigen, klicke oben auf der Seite auf die entsprechende Registerkarte.

  1. Nimm in einer JetBrains-IDE einige Änderungen an einer oder mehreren Dateien vor.

  2. Öffne das Toolfenster „Commit“ auf der linken Seite.

  3. Klicken Sie oberhalb des Eingabefelds für commit-Nachrichten auf Copilot: Codeänderungen überprüfen. Diese Schaltfläche wird als funkelndes Lupensymbol angezeigt.

  4. Copilot beginnt mit der Überprüfung Ihrer Änderungen.

  5. Copilot zeigt Kommentare in Ihrem Code mit einer Zusammenfassung der einzelnen potenziellen Probleme an. Sie können:

    • Überprüfe diese und nimm Änderungen basierend auf den Vorschlägen vor.
    • Schließe einen Kommentar, indem du auf Discard klickst.

  6. Falls mehrere Kommentare vorhanden sind, kannst du mit den Auf- und Abwärtspfeilen oben rechts im Popupmenü zwischen Kommentaren navigieren.

Voraussetzungen

Verwenden von Copilot Codeüberprüfung

In dieser Anleitung wird erläutert, wie Sie Copilot Codeüberprüfung mit dem GitHub CLI verwenden. Um Anweisungen für andere beliebte Programmierumgebungen anzuzeigen, klicke oben auf der Seite auf die entsprechende Registerkarte.

Anfordern einer Überprüfung beim Erstellen eines Pull Requests

Sie können eine Überprüfung bei Copilot anfordern, wenn Sie eine neue Pullanforderung mit gh pr create erstellen.

Shell
gh pr create --reviewer @copilot

Sie können Copilot auch interaktiv über die durchsuchbare Reviewer-Eingabeaufforderung während gh pr create auswählen.

? Reviewers  [Use arrows to move, space to select, <right> to all, <left> to none, type to filter]
  [ ]  Search (7472 more)
  [x]  monalisa (Mona Lisa)
> [x]  Copilot (AI)

Überprüfung anfordern für einen vorhandenen Pull-Request

Um eine Überprüfung von Copilot einer vorhandenen Pullanforderung anzufordern, verwenden Sie gh pr edit. Wenn Sie sich nicht auf dem Zweig des Pull-Requests befinden, geben Sie die Nummer des Pull-Requests an:

Shell
gh pr edit PR-NUMBER --add-reviewer @copilot

Ersetzen Sie PR-NUMBER durch die Nummer der Pullanforderung, die Sie überprüfen lassen möchten. Wenn Sie den Zweig des Pull-Requests ausgecheckt haben, können Sie die Nummer weglassen.