Verwenden von GitHub Copilot zum Erkunden einer Codebasis

Einführung

Wenn Sie einem Projekt zugewiesen wurden, mit dem Sie nicht vertraut sind, oder wenn Sie ein interessantes Open-Source-Projekt gefunden haben, zu dem Sie beitragen möchten, benötigen Sie einige Kenntnisse über die Codebasis, bevor Sie mit dem Vornehmen von Änderungen beginnen können. In diesem Leitfaden erfahren Sie, wie Sie GitHub Copilot Gespräch verwenden, um eine Codebasis zu erkunden und schnell mehr über das Projekt zu erfahren.

Arbeiten mit Copilot-Chat

Im Verlauf dieses Handbuchs arbeiten wir mit Copilot-Chat auf GitHub.com, das Sie unter github.com/copilot finden.

Bereitstellen des Repositorykontexts

Sie können Copilot-Chat auf eine dieser Arten zu einer Codebasis befragen.

Anfügen eines Repositorys im Chat

Durch das Anfügen eines Repositorys erhält Copilot-Chat der Zugriff auf den Code im Repository und ist am besten geeignet, wenn Sie während einer Unterhaltung zwischen Repositorys vergleichen oder wechseln möchten.

1. Navigieren Sie auf GitHub, zu github.com/copilot.
2. Klicken Sie im Textfeld auf Repositorien, Dateien und Bereiche hinzufügen und dann auf Repositorien.
3. Suchen Sie nach dem Repository, das Sie erkunden möchten, und wählen Sie es aus.

Fragen über die Repository-Seite

Sie können Copilot-Chat direkt auf der Repository-Seite in GitHub nach einem Repository fragen, ohne es zuvor anzuhängen. Dies ist eine schnelle Möglichkeit, sich in einem Projekt zu orientieren, an dem Sie noch nicht gearbeitet haben.

1. Auf GitHub navigieren Sie zu dem Repository, das Sie sich ansehen möchten.
2. Öffnen Sie Copilot-Chat auf der Repositoryseite, und stellen Sie eine Frage. Copilot verwendet das Repository als Kontext und begründet seine Antworten in den tatsächlichen Dateien und Symbolen des Repositorys.
3. Stellen Sie eine Anschlussfrage, um tiefer in das Thema einzusteigen, und verwenden Sie dabei denselben gemeinsamen Kontext.

Beispiele für Prompts

Die folgenden Eingabeaufforderungen sind Beispiele für die Art von Fragen, die Sie bei der Suche nach einer Codebasis stellen Copilot können.

Allgemeine Fragen

• Based on the code in this repository, give me an overview of the architecture of the codebase. Provide evidence.

• Give me an overview of this repository: its purpose, structure, key components, and how to run it.

• What are the main entry points and how do the key components fit together?

• Which languages are used in this repo? Show the percentages for each language.

• What are the core algorithms implemented in this repo?

• What design patterns are used in this repository? Give a brief explanation of each pattern that you find, and an example of code from this repository that uses the pattern, with a link to the file.

Spezifische Fragen

Ob diese Fragen nützlich sind, hängt von der Codebasis ab, die du untersuchst.

• How do I build this project?

• Where is authentication handled in this codebase?

• Analyze the code in this repository and tell me about the entry points for this application.

• Describe the data flow in this application.

• Analyze the code in this repository and tell me what application-level security mechanisms are employed. Provide references.

Grundlegendes zu den Dateien in einem Verzeichnis

Verwenden Sie Copilot, um den Zweck von Dateien in einem Verzeichnis oder von einzelnen Dateien zu verstehen.

So findest du Informationen zu den Dateien in einem Verzeichnis:

1. Navigieren Sie zu dem Verzeichnis auf GitHub.com.

2. Klicken Sie in der oberen rechten Ecke der Seite auf das Symbol Copilot (), um Copilot-Chat zu öffnen.

Copilot verwendet den Verzeichnisinhalt als Kontext für Ihre Frage.

1. Fragen Sie Copilot: Explain the files in this directory.

So findest du Informationen zu einer bestimmten Datei:

1. Öffnen Sie die Datei auf GitHub.com.

2. Klicken Sie in der oberen rechten Ecke der Seite auf das Symbol Copilot (), um Copilot-Chat zu öffnen.

Copilot verwendet den Dateiinhalt als Kontext für Ihre Frage.

1. Fragen Sie Copilot nach einer kleinen Datei: Explain this file.
2. Bei einer großen Datei fragen Sie Folgendes: Explain what this file does. Start with an overview of the purpose of the file. Then, in appropriately headed sections, go through each part of the file and explain what it does in detail.

Grundlegendes zu bestimmten Codezeilen

Verwenden Sie Copilot, um bestimmte Codezeilen in einer Datei besser zu verstehen.

So findest du Informationen zu einer bestimmten Codezeile:

1. Navigieren Sie auf GitHub zu einem Repository und öffnen Sie eine Datei.

2. Markieren Sie die Zeilen, indem Sie auf die Zeilennummer für die erste Zeile klicken, die Sie auswählen möchten, die Umschalttaste gedrückt halten und auf die Zeilennummer für die letzte Zeile klicken, die Sie auswählen möchten.

3. Wenn Sie Ihre eigene Frage zu den ausgewählten Zeilen stellen möchten, klicken Sie rechts neben der Auswahl auf das Copilot Symbol (). Dadurch wird das GitHub Copilot Gespräch Panel mit den ausgewählten Zeilen angezeigt, die als Kontext Ihrer Frage angegeben sind.

4. Wenn Sie eine vordefinierte Frage stellen möchten, klicken Sie neben dem Copilot Symbol auf die nach unten zeigende Schaltfläche, und wählen Sie dann eine der Optionen aus.

   

5. Wenn Sie auf das Copilot Symbol geklickt haben, geben Sie unten im Chatbereich eine Frage in das Eingabeaufforderungsfeld ein, und drücken Sie die EINGABETASTE.

Grundlegendes zu einer bestimmten Datei oder einem bestimmten Symbol

Verwenden Sie Copilot, um den Zweck einer spezifischen Datei oder eines spezifischen Symbols in der Codebasis zu verstehen. Ein Symbol ist eine benannte Entität im Code, z. B. eine Funktion, Klasse oder Variable.

1. Gehen Sie auf GitHub, wechseln Sie zu einem Repository und öffnen Sie eine Datei.

2. Klicken Sie oben in der Datei auf das Copilot Symbol (), um die Datei zu öffnen Copilot-Chat.

Copilot zeigt den Dateiinhalt in einem geteilten Bildschirm als Kontext für Ihre Frage an.

1. Wenn Sie nach einem bestimmten Symbol fragen möchten, markieren Sie das Symbol in der Datei.

2. Geben Sie im Eingabeaufforderungsfeld eine Frage zu der Datei oder dem hervorgehobenen Symbol ein, und drücken Sie die EINGABETASTE.

Copilot antwortet im Chatbereich.

Ermitteln von Commits

Eine gute Möglichkeit, sich mit einem project vertraut zu machen, besteht darin, sich die aktuelle Arbeit anzusehen, die gerade stattfindet. Du kannst dies tun, indem du die neuesten Commits durchsuchst.

1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

2. Klicke auf der Hauptseite des Repositorys über der Dateiliste auf commits.

   

3. Klicke auf eine Commit-Nachricht, um eine Diff-Ansicht für diesen Commit anzuzeigen.

4. Geben Sie im Copilot-Chat Bereich Folgendes ein: What does this commit do?.

5. Falls erforderlich, können Sie eine Nachverfolgung durchführen, indem Sie Folgendes eingeben: Explain in more detail.

Klicke auf die Registerkarte „Insights“.

Neben der Verwendung von Copilot, um sich mit einem Projekt vertraut zu machen, können Sie auch auf GitHub.com die Registerkarte Insights verwenden. So erhältst du eine allgemeine Übersicht über das Repository.

Weitere Informationen findest du unter Verwenden von Pulse zum Anzeigen einer Zusammenfassung der Repositoryaktivitäten und Mitwirkende eines Projekts anzeigen.

Weitere Informationen

• Fragen an GitHub Copilot in GitHub stellen