Verwendung der GitHub Copilot-Codeüberprüfung

Hier erfährst du, wie du einen Code Review von GitHub Copilot anforderst.

Tool navigation

In diesem Artikel

Einführung

GitHub Copilot kann deinen Code überprüfen und Feedback geben. Soweit möglich enthält das Feedback von Copilot vorgeschlagene Änderungen, die du mit ein paar Klicks anwenden kannst.

Eine vollständige Einführung in GitHub Copilot Codeüberprüfung findest du unter Informationen zu GitHub Copilot-Codeüberprüfung.

Copilot Codeüberprüfung steht auch Organisationsmitgliedern ohne Copilot-Lizenz zur Verfügung, wenn sie von einem Unternehmensadministrator oder Organisationsinhaber aktiviert wird. Siehe Copilot Codeüberprüfung für Organisationsmitglieder ohne Copilot Lizenz.

Verwendung von Copilot Codeüberprüfung

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

  1. Erstellen Sie auf GitHub.com einen Pull Request, oder navigieren Sie zu einem vorhandenen Pull Request.

  2. Öffne das Menü Reviewers und wähle dann Copilot aus.

    Screenshot der Auswahl von „Copilot“ aus dem Menü „Reviewers“.

  3. Warte, bis Copilot deinen Pull Request überprüft. Das dauert in der Regel weniger als 30 Sekunden.

  4. Scrolle nach unten, und lies die Kommentare von Copilot.

    Screenshot einer Code-Review von Copilot.

    Copilot hinterlässt immer eine "Kommentar"-Bewertung, keine "Genehmigen"-Bewertung oder eine "Änderungen anfordern"-Bewertung. Das bedeutet, dass die Reviews von Copilot nicht zu den erforderlichen Genehmigungen für den Pull Request zählen und das Mergen von Änderungen nicht durch Reviews von Copilot blockiert wird. Ausführlichere Informationen findest du unter Einen Pull Request mit erforderlichen Reviews genehmigen.

  5. Die Reviewkommentare von Copilot verhalten sich wie Reviewkommentare von Menschen. Du kannst ihnen Reaktionen hinzufügen und sie kommentieren, beheben und ausblenden.

    Alle Kommentare, die du den Reviewkommentaren von Copilot hinzufügst, sind für Menschen sichtbar. Sie sind jedoch nicht für Copilot sichtbar, und Copilot beantwortet sie nicht.

Arbeiten mit den von Copilot vorgeschlagenen Änderungen

Soweit möglich enthält das Feedback von Copilot vorgeschlagene Änderungen, die du mit ein paar Klicks anwenden kannst.

Wenn du mit den Änderungen zufrieden bist, kannst du einen einzelnen Vorschlag von Copilot akzeptieren und diesen committen, oder du kannst eine Gruppe von Vorschlägen in einem einzelnen Commit akzeptieren. Weitere Informationen finden Sie unter Feedback in Deinen Pull Request aufnehmen.

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

  • Aktivieren Sie die öffentliche Vorschau für Werkzeuge in der Copilot-Codeüberprüfung und aktivieren Sie Copilot Codierungsassistent.
  • Klicken Sie in den Überprüfungskommentaren von GitHub Copilot Codeüberprüfung auf Vorschlag implementieren. Dadurch wird ein Entwurfskommentar für den Pull-Request erstellt, in dem Sie Copilot anweisen können, auf spezifisches Feedback einzugehen. Copilot erstellt einen neuen Pull Request gegen Ihren Branch mit den angewendeten Vorschlägen.

Feedback zu Rezensionen von Copilot geben

Du kannst Feedback zu den Kommentaren von Copilot direkt innerhalb jedes Kommentars geben. Wir verwenden diese Informationen, um das Produkt und die Qualität der Vorschläge von Copilot zu verbessern.

  1. Klicke im Kommentar eines Pull-Request-Reviews von Copilot 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“.

  2. Wenn du auf die Schaltfläche „Daumen nach unten“ klickst, wirst du dazu aufgefordert, zusätzliche Informationen anzugeben. Optional kannst du den Grund für dein negatives Feedback auswählen und einen Kommentar hinterlassen, bevor du auf Submit feedback klickst.

    Screenshot des Formulars zum Bereitstellen zusätzlicher Informationen, wenn du negatives Feedback zu einem Kommentar von Copilot gibst

Anfordern eines erneuten Reviews von Copilot

Wenn du Änderungen an einen Pull Request pushst, die von Copilot überprüft wurden, werden deine Änderungen nicht automatisch erneut überprüft.

Um einen erneuten Review von Copilot anzufordern, klicke im Menü Reviewers auf die Schaltfläche neben dem Name von Copilot. Weitere Informationen finden Sie unter Eine Überprüfung der Pull-Anfrage anfordern.

Hinweis

Wenn du einen Pull Request erneut überprüfst, könnte Copilot dieselben Kommentare wiederholen, auch wenn sie mit der Schaltfläche „Gespräch auflösen“ verworfen oder mit der Schaltfläche „Daumen nach unten“ (👎) abgelehnt wurden.

Aktivieren automatischer Reviews

Standardmäßig forderst du ein Review von Copilot für jeden Pull Request manuell an, und zwar auf die gleiche Weise wie ein Review durch einen Menschen. Du kannst jedoch Copilot einrichten, um alle Pull Requests automatisch zu überprüfen. Weitere Informationen findest du unter Konfigurieren der automatischen Codeüberprüfung durch GitHub Copilot.

Anpassen der Bewertungen von Copilot 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

  • 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 Codierungsassistent.
  • 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.

Überprüfen einer Auswahl an Code

Du kannst in Visual Studio Code eine erste Überprüfung der hervorgehobenen Codeauswahl anfordern.

  1. Wähle in Visual Studio Code den Code aus, den überprüfen möchtest.
  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 Kommentare in der Kommentare-Leiste und zeigt sie auch direkt im Editor an.

Überprüfen aller nicht committeten Änderungen

Du kannst eine Überprüfung nicht committeter Änderungen in Visual Studio Code anfordern.

  1. Klicke in VS Code auf die Schaltfläche Source Control in der Aktivitätsleiste.

  2. Zeige oben in der Ansicht Source Control auf CHANGES, und klicke dann auf die Schaltfläche Copilot Code Review - Uncommitted Changes.

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

  3. Warte, bis Copilot deine Änderungen überprüft. Das dauert in der Regel weniger als 30 Sekunden.

  4. Wenn Copilot Kommentare hat, werden diese in deiner Datei bzw. deinen Dateien als Inlinekommentare und auf der Registerkarte Probleme angezeigt.

Arbeiten mit den von Copilot vorgeschlagenen Änderungen

Soweit möglich enthält das Feedback von Copilot vorgeschlagene Änderungen, die du mit einem einzigen Klick anwenden kannst.

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

Wenn du mit der Änderung zufrieden bist, kannst du einen Vorschlag von Copilot akzeptieren, indem du auf die Schaltfläche Apply and Go To Next klickst. Alle von dir angewendeten Änderungen werden nicht automatisch übernommen.

Wenn du die vorgeschlagene Änderung von Copilot nicht anwenden möchten, klicke auf die Schaltfläche Discard and Go to Next.

Feedback zu Rezensionen von Copilot geben

Du kannst Feedback zu den Kommentaren von Copilot direkt innerhalb jedes Kommentars 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 der Bewertungen von Copilot 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

  • 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 Codierungsassistent.
  • 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

Um Copilot Codeüberprüfung zu nutzen, musst du Visual Studio Version 17.14 oder höher verwenden. Weitere Informationen findest du auf der Downloadseite von Visual Studio.

Verwendung von Copilot Codeüberprüfung

In diesen Anweisungen wird erläutert, wie du den Copilot Codeüberprüfung in Visual Studio verwenden kannst. Um Anweisungen für andere beliebte Programmierumgebungen anzuzeigen, klicke oben auf der Seite auf die entsprechende Registerkarte.

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

  2. Copilot beginnt mit der Überprüfung deiner Ä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 wurden, wird die folgende Meldung angezeigt: Copilot hat keine Dateien kommentiert.

  4. Copilot zeigt Kommentare in deinem 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 Reviewkommentare zu entfernen, klicke auf neben dem Reviewlink im Fenster „Git Changes“.

Weitere Informationen zum Aktivieren und Konfigurieren von Copilot Codeüberprüfung in Visual Studio finden Sie unter Lokale Änderungen mit Copilot-Chatin der Dokumentation zu Visual Studio.

Verwendung von Copilot Codeüberprüfung

In diesen Anleitungen wird erklärt, wie du den Copilot Codeüberprüfung in GitHub Mobile verwenden kannst. Um Anweisungen für andere beliebte Programmierumgebungen anzuzeigen, klicke oben auf der Seite auf die entsprechende Registerkarte.

  1. Öffne in GitHub Mobile einen Pull Request.
  2. Scrolle nach unten zum Abschnitt Reviews, und erweitere ihn.
  3. Klicke auf Request Reviews.
  4. Füge Copilot als Reviewer hinzu, und klicke auf Done.

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

Voraussetzung

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

Verwendung von Copilot Codeüberprüfung

In diesen Anweisungen wird erläutert, wie du Copilot Codeüberprüfung in Xcode verwendest. 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. Öffne das Chatfenster von Copilot, indem du in der Menüleiste auf Editor, auf GitHub Copilot und dann auf Open Chat klickst.

  3. Klicke unten rechts im Promptfeld im Chatfenster von Copilot auf die Schaltfläche Code Review (Sprechblasensymbol).

    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. Klicke auf die Kontrollkästchen, um Dateien abzuwählen, die Copilot nicht überprüfen soll.

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

  7. Wenn Copilot Dinge findet, die kommentiert werden müssen, wird im Chatfenster eine Liste Reviewed Changes mit den Dateien angezeigt, denen Kommentare hinzugefügt 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 schlägt Ersatzcode vor. 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 [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot).

  •         **Kompatible JetBrains-IDE**. Um GitHub Copilot in JetBrains zu verwenden, muss eine kompatible JetBrains-IDE installiert sein. GitHub Copilot ist mit den folgenden IDEs kompatibel:
    • IntelliJ IDEA (Ultimate, Community, Educational)
    • Android Studio
    • AppCode
    • CLion
    • Code With Me (Gast)
    • DataGrip
    • DataSpell
    • GoLand
    • JetBrains-Client
    • MPS
    • PhpStorm
    • PyCharm (Professional, Community, Educational)
    • Rider
    • RubyMine
    • RostRover
    • WebStorm
    • Writerside

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

  •         **Die aktuellste Version der GitHub Copilot-Erweiterung**. Siehe [GitHub Copilot-Plugin](https://plugins.jetbrains.com/plugin/17718-github-copilot?ref_product=copilot&ref_type=engagement&ref_style=text) im JetBrains Marketplace. Anweisungen zum Installieren findest du unter [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment).

  •         **Melde dich bei GitHub in deiner JetBrains-IDE an**. Anweisungen zum Authentifizieren findest du unter [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment?tool=jetbrains#installing-the-github-copilot-plugin-in-your-jetbrains-ide).

Verwendung von Copilot Codeüberprüfung

In diesen Anweisungen wird erläutert, wie du Copilot Codeüberprüfung in JetBrains-IDEs verwendest. 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. Klicke oberhalb des Eingabefelds der Commitnachricht auf Copilot: Review Code Changes. Diese Schaltfläche wird als funkelndes Lupensymbol angezeigt.

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

  5. Copilot zeigt Kommentare in deinem 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.