Verwenden von GitHub Copilot zum Erkunden einer Codebasis

GitHub Copilot Chat kann dir helfen, dich mit dem Inhalt, der Struktur und der Funktionalität einer Codebasis vertraut zu machen.

In diesem Artikel

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 Handbuch erfahren Sie, wie Sie GitHub Copilot Chat verwenden, um eine Codebasis zu erkunden und schnell mehr über das Projekt zu erfahren.

Arbeiten mit Copilot-Chat

In diesem Leitfaden arbeiten wir mit Copilot-Chat auf GitHub.com, die Sie unter github.com/copilot finden können.

Anfügen einer Codebasis

Bevor Ihnen % data variables.copilot.copilot_chat_short %} helfen können, müssen Sie die Codebasis anfügen, die Sie untersuchen möchten.

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

Copilot-Chat hat nun Zugriff auf den Code in diesem Repository, und Sie können damit beginnen, Fragen zu diesem Code zu stellen.

Beispiele für Prompts

Die folgenden Prompts sind Beispiele für die Art von Fragen, die du Copilot stellen kannst, um mehr zur Codebasis zu erfahren.

Allgemeine Fragen

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

  • 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

Verwende Copilot, um den Zweck der Dateien in einem Verzeichnis oder einzelnen Dateien zu verstehen.

So findest du Informationen zu den Dateien in einem Verzeichnis:

  1. Navigiere zu einem Verzeichnis auf GitHub.com.

  2. Klicken Sie oben rechts auf der Seite auf das Symbol Copilot (), um Copilot-Chat zu öffnen.

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

  3. Übermittle folgenden Prompt an Copilot: Explain the files in this directory

So findest du Informationen zu einer bestimmten Datei:

  1. Öffne die Datei auf GitHub.com.

  2. Klicken Sie oben rechts auf der Seite auf das Symbol Copilot (), um Copilot-Chat zu öffnen.

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

  3. Bei einer kleinen Datei fragen Sie Copilot: Explain this file.

  4. 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

Verwende Copilot, um bestimmte Codezeilen in einer Datei zu verstehen.

So findest du Informationen zu einer bestimmten Codezeile:

  1. Navigieren Sie auf GitHubzu 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. Um eine eigene Frage zu den ausgewählten Zeilen zu stellen, klicke rechts in deiner Auswahl auf das Copilot-Symbol (). Dadurch wird das GitHub Copilot Chat-Panel angezeigt, in dem die ausgewählten Zeilen als Kontext deiner Frage angegeben sind.

  4. Um eine vordefinierte Frage zu stellen, klicken Sie neben dem SymbolCopilot auf die nach unten zeigende Schaltfläche, und wählen Sie dann eine der Optionen aus.

    Screenshot der SchaltflächenCopilot, hervorgehoben mit dunkel-orangefarbener Umrandung rechts neben dem ausgewählten Code.

  5. Wenn du auf das Symbol Copilot geklickt hast, gib unten im Chatbereich eine Frage in das Promptfeld ein, und drücke die EINGABETASTE.

Grundlegendes zu einer bestimmten Datei oder einem bestimmten Symbol

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

  1. Navigieren Sie auf GitHubzu einem Repository, und öffnen Sie eine Datei.

  2. Klicken Sie oben rechts auf der Seite auf das Symbol Copilot (), um Copilot-Chat zu öffnen.

    Copilot zeigt den Dateiinhalt in einem geteilten Bildschirm an, als Kontext zu Ihrer Frage.

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

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

    Copilot antwortet im Chatbereich.

    Tipp

    Die Fähigkeit von Copilot, Fragen in natürlicher Sprache wie diese im Kontext eines Repository zu beantworten, wird optimiert, wenn der Index der semantischen Codesuche für das Repository auf dem neuesten Stand ist. Weitere Informationen finden Sie unter Indizierungsrepositorys für GitHub Copilot.

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.

    Screenshot der Hauptseite für ein Repository. Ein Uhrensymbol mit der Bezeichnung „178 Commits“ ist orange umrandet.

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

  4. Gib Folgendes in das Copilot-Chat-Panel 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“.

Zusätzlich zur Verwendung von Copilot, um sich mit einem Projekt vertraut zu machen, können Sie auch die Registerkarte Insights auf GitHub.com 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

  •         [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github)