Inwiefern kann ich meine Kenntnisse durch Code auf GitHub erweitern?
Das Lernen durch Projekte auf GitHub stellt eine großartige Möglichkeit dar, sich neue Techniken anzueignen und für eigene Projekte inspirieren zu lassen.
Da Millionen öffentlich verfügbarer Repositorys auf GitHub verfügbar sind, kann es jedoch überfordernd sein, Code zu finden, der für das Projekt geeignet ist. Selbst wenn du das perfekte Repository gefunden hast, kann es schwierig sein, die Codebasis nach nützlichen Beispielen zu durchsuchen.
Anstatt zu versuchen, ein ganzes Projekt zu verstehen, besteht ein besserer Ansatz darin, einzelne Features oder Funktionen auszuwählen und herauszufinden, wie sie funktionieren. Die Suchfunktionalität von Copilot-Chat und GitHub kann verwendet werden, um nach einem Feature zu suchen und damit die Codebasis zu durchlaufen. Dies ist eine großartige Möglichkeit, um zu lernen, wie das Feature vom Back-End bis zum Front-End funktioniert.
In diesem Leitfaden erfährst du mithilfe eines Beispielszenarios, wie du Daten aus Dateien auf einer Jekyll-Website lädst und anzeigst. Anschließend kannst du die Tipps und Techniken auf andere Projekte und Programmiersprachen anwenden.
Suchen eines Beispielprojekts
Der erste Schritt besteht darin, das richtige Projekt zu finden, das als Lerngrundlage dient.
Verwenden Sie Copilot-Chat, um ein Repository zu identifizieren.
Die schnellste Möglichkeit, ein Projekt mit Code zu finden, von dem du lernen kannst, besteht darin, Copilot-Chat aufzufordern, Repositorys zurückzugeben, die deinen Anforderungen entsprechen.
Öffne Copilot-Chat, und starte einen allgemeinen Chat. Stelle dann die folgende Frage:
Kannst du einige beliebte Repositorys suchen, die Jekyll zum Anzeigen von Daten aus Dateien im Repository verwenden?
Copilot gibt Links zu relevanten Repositorys zurück, und du kannst Folgefragen zu den Repositorys stellen.
Oft fügt Copilot am Ende der Antwort einen Link zur GitHub-Suche mit weiteren Ergebnissen ein. Als Nächstes überprüfen wir diese Ergebnisse.
Verwenden der Suche zum Identifizieren weiterer Optionen
Wenn Copilot einen Link zu den Suchergebnissen eingefügt hat, klicke auf diesen Link. Falls nicht, formuliere eine eigene Suchanfrage, indem du die folgenden Schritte befolgst.
- Navigiere zu Advanced search.
- Verwende im Abschnitt „Erweiterte Optionen“ die Dropdownliste „Geschrieben in dieser Sprache“, um eine Programmiersprache auszuwählen. Wähle für die Jekyll-Website die Option „HTML“ aus.
- Optional kannst du unter „Repository-Optionen“ neben „Mit dieser Anzahl von Sternen“ Folgendes eingeben. Dies hilft dir dabei, beliebte Repositorys zu finden, die wahrscheinlich gut organisiert sind.
- Klicke oben auf der Seite auf Suche.
Tipp
Du kannst die Suchergebnisse weiter eingrenzen, indem du der Suchanfrage Themen und Text hinzufügst. Beispielsweise gibt Repositorys zurück, die der Eigentümer als zu Jekyll gehörend klassifiziert hat und die das Wort „blog“ im Namen oder der Beschreibung des Repositorys enthalten. Eine Liste beliebter Themen findest du unter Themen auf GitHub.
Auswählen eines Projekts
Nach dem Überprüfen der Ergebnisse von Copilot und der Suchprozesse entscheiden wir uns, das Repository zu verwenden. Dieses Repository enthält den Quellcode für Choose a License, eine Jekyll-Website, die Informationen zu Open Source Lizenzen teilt.
Wir interessieren uns besonders für die Seite Licenses, die beliebte Open Source Lizenzen aus Datendateien anzeigt.
Orientierung im Projekt
Bevor du dich mit dem Code zum Anzeigen von Datendateien beschäftigst, mache dich zunächst grundsätzlich mit dem Repository vertraut.
Es kann schwierig sein, einen Ausgangspunkt zu ermitteln, wenn du ein Repository zum ersten Mal öffnest. Obwohl alle Projekte auf individuelle Weise organisiert sind, gibt es allgemeine Dokumentationsmethoden, die dir in der Regel dabei helfen, dich zurechtzufinden.
Datei „README.md“
Es empfiehlt sich immer, die Datei README.md zu lesen, bei der es sich um die Startseite eines Repositorys handelt und die automatisch unter der Liste der Dateien gerendert wird. Die enthaltenen Informationen können je nach Verantwortlichen für die Projektverwaltung variieren, aber oft findet man Informationen zum Projekt, zur Durchführung auf dem eigenen Rechner und Links zur Dokumentation.
Im Repository erklärt die Datei „README.md“, wo sich die Lizenzdateien () befinden, welche Attribute die jeweiligen Lizenzen haben können und wie du die Website auf deinem Computer aufrufen kannst.
Verwenden von Copilot-Chat
Wenn die Datei „README.md“ nicht die gewünschten Informationen enthält, kannst du Copilot auffordern, dir bei der Navigation durch das Repository und der Suche nach Funktionen zu helfen.
Klicke zum Öffnen von Copilot-Chat neben der Suchleiste auf das Symbol , und stelle deine Frage. Zum Beispiel:
Was ist die Hauptstartseite für diese Jekyll-Website?
Wenn du Copilot Fragen zu einem Repository stellst, kann das Tool die relevanten Dateien zurückgeben, ihre Rolle hinsichtlich der Funktionalität erklären und Links einschließen.
Wiki des Repositorys
Eine weitere Informationsquelle ist das Wiki des Repositorys. Hierbei handelt es sich um einen Abschnitt des Repositorys speziell für das Hosten der Dokumentation. Bei jedem Repository auf GitHub besteht die Möglichkeit, ein Wiki zu verwenden, aber nicht für jedes Repository wird diese Option genutzt. Klicke im Repository auf die Registerkarte Wiki, um auf das Wiki zuzugreifen.
Veröffentlichungen
Wenn der Quellcode des Repositorys in eine ausführbare Datei integriert ist, verwenden einige Personen, die das Repository verwalten, die Releases des Repositorys, um Binärdateien zu veröffentlichen. Du kannst diese Binärdateien herunterladen und ausführen, um während dem Erkunden der Codebasis zu untersuchen, wie die Anwendung funktioniert, ohne das Projekt selbst erstellen zu müssen.
Du findest die Releases eines Repositorys auf der Randleiste rechts neben der Liste der Dateien und der README.md-Datei.
Interne Dokumentation
Du kannst auch im Inhalt des Repositorys nach der internen Dokumentation suchen. Dies kann eine einzelne Markdowndatei oder ein Verzeichnis voller Markdowndateien sein. Du kannst nach gängigen Bezeichnungen wie „docs“, „documentation“, „wiki“, „resources“, „help“ oder „manual“ suchen.
Navigieren im Quellcode
Da du nun die Gesamtstruktur des Repository kennst, kannst du die GitHub-Suche verwenden, um nach der spezifischen gewünschten Funktion zu suchen.
Wenn du dich in einem Repository befindest und in das Suchfeld oben auf der Seite klickst, fügt GitHub automatisch den Suchqualifizierer hinzu, sodass die Suchergebnisse auf das angezeigte Repository beschränkt sind.
Zunächst musst du wissen, wonach du suchen möchtest. Dies kann eine Zeichenfolge mit eindeutigem Text für das Feature sein, das wir untersuchen, oder wir könnten uns den HTML-Quellcode der Seite ansehen und ein bestimmtes -oder -Attribut ermitteln.
In unserem Beispiel suchen wir oben auf der Lizenzseite nach dem Text mit dieser Abfrage: . Daraufhin wird ein Ergebnis angezeigt: eine Datei namens .
Jetzt können wir auf das Ergebnis klicken und tiefer eintauchen! ist die Quelle der Seite „Lizenzen“, nach der Sie gesucht haben. Die gesuchte Zeichenfolge wird angezeigt, und jede der Lizenzen ist im folgenden Code enthalten:
{% include license-overview.html license-id="agpl-3.0" %}
Verstehen des Quellcodes
Nachdem du nun den gewünschten spezifischen Code gefunden hast, kannst du ihn genauer untersuchen, um ihn zu verstehen.
Frage an Copilot-Chat zu dem Code
Du kannst Copilot verwenden, um mehr über eine Datei oder sogar bestimmte Codezeilen zu erfahren. Copilot kombiniert Informationen zur Programmiersprache mit dem Kontext aus dem Repository, um deine Fragen detailliert zu beantworten.
Fragen wir Copilot danach, was in Zeile 11 mit dem -Tag geschieht. Klicke auf die Zeilennummer. Klicke dann rechts von der Zeile auf . Stelle im Chatfenster die folgende Frage:
Was geschieht in dieser Zeile?
Copilot erläutert dann, dass die Zeile die Datei einschließt und diese mit als zur Anzeige übergibt.
Tipp
Wenn du eine Antwort von Copilot-Chat nicht verstehst, kannst du das Tool immer darum bitten, die Antwort zu vereinfachen oder einen bestimmten Teil davon ausführlicher zu erläutern.
Lesen von Kommentaren
Kommentare sind von Menschen erstellte, lesbare Anmerkungen, die du nutzen kannst, um den Code zu verstehen. Sie werden nicht ausgeführt. Sie sind in der Regel durch Zeichen wie oder getrennt.
Es gibt einige Arten von Kommentaren, nach denen du suchen kannst:
- Zeile: Einzeilige Kommentare, die beschreiben, welchen Zweck eine bestimmte Zeile erfüllt
- Block: Mehrzeilige Kommentare, die beschreiben können, welchen Zweck eine gesamte Funktion oder Datei erfüllt
- Datei: Blockkommentar am Anfang einer Datei, der einen Überblick über diesen bestimmten Teil der Codebasis bietet
Nachschlagen von Funktionen in Programmiersprachreferenzen
Für jede Programmiersprache ist eine Onlinereferenz verfügbar, in der jeder Aspekt der Sprache erläutert wird.
Wenn du eine Suchmaschine für die Suche nach der Programmiersprache und der Funktion verwendest, sollte ein Link zur Referenzseite dieser Funktion angezeigt werden.
In unserem Beispiel sollte bei der Suche nach in einer Suchmaschine die „Includes“-Dokumentation in der Jekyll-Dokumentation angezeigt werden. Wenn wir in der Jekyll-Dokumentation weiter lesen, erkennen wir, dass die Lizenzen selbst eine Sammlung im -Verzeichnis sind.
Tipp
Wenn du eine Funktion in der Referenz zu einer Programmiersprache nicht finden kannst, ist es wahrscheinlich, dass die Funktion in der Codebasis selbst definiert ist. Fordere GitHub Copilot auf, danach zu suchen.
Zusammenfassung dessen, was wir gelernt haben: Die Datei enthält Informationen für jede angezeigte Lizenz. Die Datei stimmt mit den für eine Lizenz bereitgestellten Daten in der Sammlung überein und zeigt die Details an.
Experimentieren mit kleinen Änderungen
Wenn du das Projekt lokal auf deinem Computer ausführen kannst, empfiehlt es sich, kleine Änderungen vorzunehmen, um herauszufinden, was passiert.
Du kannst zunächst Text ändern und anschließend größere Änderungen vornehmen (z. B. Experimentieren mit Funktionen und Dateien, um festzustellen, wie diese miteinander interagieren).
Suche die Datei im Verzeichnis und nimm dann Änderungen vor, um die Anzeige der Lizenz zu ändern oder experimentiere damit, wie die Lizenz aus der Sammlung geladen wird.
Du hast die Möglichkeit, die Metadaten am Anfang einer der Lizenzdateien zu ändern, die in angezeigten Attribute zu bearbeiten oder sogar eigene Attribute hinzuzufügen. Wenn du deine Änderungen vorgenommen hast, kannst du die Funktionalität testen, indem du die Anweisungen in der README.md-Datei befolgst, um sie im Browser anzuzeigen.
Anwenden der neuen Kenntnisse
Das Repository ist ein gutes Beispiel für ein großes Jekyll-Projekt und zeigt, was mit Jekyll und GitHub Pages möglich ist. Kannst du all das anwenden, was du hinsichtlich der Struktur des Repositorys, der Verwendung von Sammlungen und der Methode zum Einschließen von Lizenzdaten gelernt hast, um dein eigenes Projekt zu erstellen?
Nächste Schritte
Da du nun verstehst, wie der Beispielcode funktioniert, solltest du ihn in deinem eigenen Projekt wiederverwenden. Das Wiederverwenden von Code ist ein wichtiger Teil der Softwareentwicklung, aber es müssen bestimmte Schritte befolgt werden, um sicherzustellen, dass die Vorgänge ordnungsgemäß und gesetzeskonform ausgeführt werden. Ein vollständiges Tutorial findest du unter AUTOTITLE.