GitHub für Anfänger: Erste Schritte mit OSS-Beiträgen

Willkommen zurück bei GitHub für Anfänger. Bisher haben wir GitHub-Probleme und -Projekte, GitHub-Aktionen, Sicherheit, GitHub-Seiten und Markdown. Dieses Mal werden wir über Open-Source-Software sprechen und darüber, wie man zu dieser Community beitragen kann. Am Ende dieses Beitrags wissen Sie, was Open Source ist, wie Sie Projekte finden, an denen Sie arbeiten können, wie Sie ein Open Source-Repository lesen und mit dem Einbringen Ihrer ersten Beiträge beginnen können. Also fangen wir an!

Wenn Sie sich das Video lieber ansehen oder darauf verweisen möchten, haben wir wie immer alle unsere GitHub for Beginners-Episoden auf YouTube verfügbar.

Was ist Open Source?

Open-Source-Software (OSS) bezieht sich auf Software, die über frei verfügbaren Quellcode verfügt. Im Gegensatz zu „Closed-Source-Software“ ist OSS öffentlich verfügbar und kann von jedem genutzt und darauf aufgebaut werden. Das bedeutet, dass die gesamte Arbeit, einschließlich der Codebasis und der Kommunikation zwischen Benutzern, für jeden sichtbar ist.

Wenn Sie gerade erst in die Welt der Softwareentwicklung einsteigen, ist das Durchsuchen und Mitwirken an Open-Source-Projekten eine großartige Möglichkeit, in große, wirkungsvolle Projekte einzutauchen, die von unzähligen Benutzern weltweit genutzt werden.

GitHub ist die Heimat für Open-Source-Software. Schauen wir uns also an, wie Sie Projekte finden, zu denen Sie beitragen können.

So finden Sie OSS-Projekte, an denen Sie arbeiten können

Der erste Beitrag zu einem Open-Source-Softwareprojekt kann entmutigend sein – das kennen wir alle! Der erste Schritt besteht darin, nach Projekten in einer Ihnen bekannten Sprache zu suchen, die neue Mitwirkende aufnehmen. Eine Möglichkeit, dies zu tun, besteht darin, GitHub Copilot Chat um Hilfe zu bitten.

• Navigieren Sie zu github.com und wählen Sie das Copilot-Symbol aus, um ein Chat-Fenster zu öffnen.
• Verwenden Sie in der unteren linken Ecke des Chat-Fensters das Kombinationsfeld, um Fragen auszuwählen.
• Geben Sie eine Eingabeaufforderung wie die folgende ein, aber denken Sie daran, sie auf eine Sprache zu aktualisieren, mit der Sie vertraut sind.

Ich suche nach einer Liste von in TypeScript geschriebenen Open-Source-Projekten, die neue Mitwirkende akzeptieren. Durchsuchen Sie GitHub und grenzen Sie die Liste auf Repositories ein, die das Label „Gute Erstausgabe“ verwenden und über 100 Sterne auf GitHub haben. 

Copilot führt eine Suche durch und gibt eine Liste von Projekten zurück, die Sie erkunden können, gefiltert nach dem Label gute erste Ausgabe. Dieses Label weist darauf hin, dass eine Ausgabe für Anfänger geeignet und ein guter Ausgangspunkt für neue Mitwirkende ist. Dieses Label ist eine großartige Möglichkeit, Probleme in einem Projekt zu finden, an dem Sie arbeiten können.

Angenommen, Sie möchten zum vscode-Repository beitragen.

1. Navigieren Sie zum vscode-Repository.
2. Wählen Sie oben im Repository die Registerkarte Probleme aus.
3. Klicken Sie auf der Seite „Probleme“ auf das Feld Beschriftungen, um das Dropdown-Menü zu öffnen.
4. Geben Sie im Textfeld des Dropdown-Menüs „gut“ ein, bis Sie die Option „gute erste Ausgabe“ sehen.
5. Wählen Sie das Label gute erste Ausgabe aus.

Das Fenster wird aktualisiert und zeigt eine Liste guter erster Probleme an, an denen Sie arbeiten können. Aber bevor Sie loslegen, sollten Sie den Leitfaden für Mitwirkende im Repository des Projekts lesen. Die meisten gut gepflegten Open-Source-Projekte verfügen über eine.

Ein Open-Source-Projekt verstehen

Wie wir gerade angedeutet haben, haben die meisten Open-Source-Projekte einige Gemeinsamkeiten, wenn sie gut gepflegt werden. Dies sind die folgenden Elemente:

• Eine gut dokumentierte README-Datei mit Installationsanweisungen.
• Ein Leitfaden für Mitwirkende, der erklärt, wie man einen Beitrag leistet.
• Eine Open-Source-Lizenz, sodass jeder weiß, dass die Nutzung des Projekts kostenlos ist.
• Mindestens 100 GitHub-Sterne, um zu zeigen, dass es in der Community verwendet wird.
• Aktive Entwicklung, damit Sie wissen, dass ein Betreuer des Quellcodes Ihre Beiträge überprüfen kann.
• Ein Gute erste Ausgabe-Label, das darauf hinweist, dass es für neue Mitwirkende offen ist.

Wenn Sie nach einem Projekt suchen, zu dem Sie beitragen können, sollten Sie in einem Repository nach diesen Dingen suchen.

💡 Weitere Dokumentation zum Finden eines guten Open-Source-Projekts finden Sie unter gh.io/gfb-oss, um mehr über das Finden guter Erstausgaben zu erfahren.

Einen OSS-Beitrag leisten

Schauen wir uns nun ein konkretes Projekt an und überlegen, wie Sie Ihre erste Ausgabe einreichen würden. Werfen Sie für diese Demo einen Blick auf das gitfolio-Repository. Anhand der obigen Aufzählungspunkte möchten wir sehen, ob dies ein gutes Projekt für die Arbeit wäre.

• Das Projekt verfügt über eine gut dokumentierte README-Datei.
• Das Projekt verfügt über einen Leitfaden für Mitwirkende: CONTRIBUTING.md.
• Sie können die Open-Source-Lizenz sehen: LIZENZ.
• Es hat mehrere tausend Sterne und liegt damit weit über unserem 100er-Benchmark.
• Oben in der Dateiliste sehen Sie den letzten Check-in, der relativ aktuell sein sollte. Während ich dies schreibe, war der letzte Check-in gestern, was darauf hindeutet, dass das Projekt aktiv gepflegt wird.

Auf der Grundlage dieser Punkte ist dies ein gutes Repository, zu dem Sie beitragen können, sofern Sie mit TypeScript vertraut sind. Sie müssen jedoch nicht mit TypeScript vertraut sein, um der Demo folgen zu können.

Jetzt möchten Sie einen Zweig des Repositorys erstellen. Ein Fork ist eine Kopie des Repositorys, mit der wir frei experimentieren und Änderungen vornehmen können, ohne das ursprüngliche Projekt zu beeinträchtigen. Normalerweise verwenden wir Forks für Open-Source-Beiträge. Wenn Sie eine Auffrischung zum Forken eines Repositorys benötigen, schauen Sie sich diesen vorherigen GitHub for Beginners-Blog an.

1. Navigieren Sie zur Startseite des Projekts, falls Sie noch nicht dort sind.
2. Klicken Sie oben im Projekt auf die Schaltfläche Fork.
3. Belassen Sie sich im neuen Fenster als Eigentümer und stellen Sie sicher, dass der „Repository-Name“ mit dem ursprünglichen Repository übereinstimmt (d. h. „gitfolio“).
4. Wählen Sie unten im Fenster Fork erstellen aus.
5. Klicken Sie in Ihrer abgezweigten Kopie des Repositorys in der Liste der Dateien auf README.md.
6. Ändern Sie die Datei, indem Sie etwas Text hinzufügen.
7. Wählen Sie oben rechts die Option Änderungen übernehmen…

aus

8. Stellen Sie sicher, dass Sie unten die Option Neuen Zweig aus diesem Commit erstellen auswählen und eine Pull-Anfrage starten.
9. Wählen Sie Änderungen vorschlagen.
10. Klicken Sie im folgenden Fenster auf die Schaltfläche Pull-Anfrage erstellen. Dadurch können Sie von Ihrem Zweig aus eine Pull-Anfrage an das Haupt-Repository mit den Änderungen erstellen.
11. Wählen Sie oben im Fenster „Pull-Anfrage öffnen“ die Option Vergleich zwischen Forks aus. Dadurch werden die Änderungen Ihres Forks im Vergleich zum Original-Repository angezeigt.
12. Wenn Sie eine tatsächliche Änderung an das Repository übermitteln würden und nicht nur eine Demo durchgehen würden, würden Sie Ihrer Pull-Anfrage hier einen Titel und eine Beschreibung geben. Sie möchten in der Beschreibung der Pull-Anfrage auch einen Link zu dem Problem angeben, das Sie gelöst haben.

An diesem Punkt können Sie Ihre Pull-Anfrage senden, indem Sie auf die Schaltfläche unten im Fenster klicken. Sobald Sie dies jedoch tun, handelt es sich nicht mehr nur um eine Änderung in Ihrem Fork, sondern um ein angefordertes Update des ursprünglichen Repositorys. Aus diesem Grund ist es in den obigen Schritten nicht enthalten. Wenn Sie Ihre Pull-Anfrage einreichen, ist sie verfügbar und kann von einem Betreuer überprüft und hoffentlich genehmigt werden!

Nach der Genehmigung und Zusammenführung übernimmt GitHub die Änderungen von Ihrem Fork automatisch in den Hauptzweig des ursprünglichen Repositorys, der offiziellen Quelle der Wahrheit für die Codebasis.

Was kommt als nächstes?

Herzlichen Glückwunsch! Sie haben gelernt, wie Sie eigene Beiträge zu Open-Source-Software leisten können. Ich hoffe, es inspiriert Sie, zu Ihren Lieblingsprojekten beizutragen.

Und wenn Sie weitere Informationen suchen, haben wir zahlreiche Dokumentationen, die Ihnen weiterhelfen können. Hier sind ein paar Links zur Information:

• Möglichkeiten finden, zu Open Source auf GitHub beizutragen
• Beitrag zu Open-Source-Projekten
• Beitrag zu einem Projekt durch Forking

Viel Spaß beim Codieren!

Der Beitrag GitHub für Anfänger: Erste Schritte mit OSS-Beiträgen erschien zuerst auf dem GitHub-Blog.

Zur Originalquelle gehen