Einen effektiven Beitrag zu Open Source-Projekten leisten Webmaker

Was Sie erstellen werden

Ein Beitrag zu Open Source-Projekten hat viele Vorteile. Während Sie zu einem solchen Projekt beitragen, lernen Sie die professionelle Art der Entwicklung kennen, die von großen Organisationen bereitgestellt wird. Solche Fähigkeiten erweisen sich als sehr nützlich für die Karriere der Menschen und helfen ihnen, Dinge zu lernen, die sie möglicherweise während ihrer Ausbildung / Arbeit nicht lernen können.

Dieser Artikel wurde für Anfänger und Fortgeschrittene entwickelt, die zu Open Source-Projekten beitragen möchten. Ich werde einen Beitrag zum Webmaker-Projekt der Mozilla Foundation zeigen, um zu erläutern, wie Sie effektiv zu Open Source-Projekten beitragen können.

Fallstudie: Mozilla Webmaker

Wir werden den gesamten Prozess der Einbindung in ein Projekt durchlaufen, vom Verständnis der Richtlinien für das Mitmachen über die Verwendung eines GitHub-Kontos und der Verwendung von Git bis zur effizienten Verwendung von Bugzilla. In diesem Lernprogramm wird gezeigt, wie Sie Ihre Patches in die Hauptcodebase eines Projekts einbinden können. Ich werde das Beispiel eines alten und einfachen Fehlers verwenden, den ich behoben habe, als ich gerade mit dem Open Source-Beitrag begonnen hatte.

Zunächst müssen Sie das Repository des Projekts finden. Zum Beispiel arbeiten wir an der Profil Bestandteil von Webmaker.

https://github.com/mozilla/webmaker-profile-2

Melden Sie sich bei Ihrem GitHub-Konto an und Gabel das Projekt. Danach befindet sich das verzweigte Repository unter Ihrem Benutzernamen.

Zum Beispiel hatte ich Folgendes:

https://github.com/tanay1337/webmaker-profile-2

Sie müssen Git auf Ihrem System installiert haben. Sie können die Richtlinien dazu lesen.

Auf der unteren rechten Seite sehen Sie eine Box wie diese:

Sie können diese URL kopieren, um das Repository in Ihrem System zu klonen. Führen Sie nun Git im Befehlszeilenmodus aus und geben Sie den folgenden Befehl ein.

git clone https://github.com/tanay1337/webmaker-profile-2.git

Dadurch wird der gesamte Code unter einem Ordner mit dem Namen in Ihr System importiert Webmaker-Profil-2. Mitwirkende Richtlinien sind normalerweise in einer Datei vorhanden CONTRIBUTING.md und Installationsanweisungen sind in README.md. Lesen Sie diese beiden Dokumente sehr sorgfältig. Sie enthalten wichtige Informationen für Entwickler.

Betritt Bugzilla!

Nun müssen Sie zunächst einige relevante und einfache Fehler finden. Für jedes Mozilla-bezogene Projekt können Sie Bugs Ahoy verwenden, um gute erste Fehler zu finden, und um gemachte Fehler, die für Ihre Fähigkeiten spezifisch sind. Mozilla verwendet Bugzilla zur Fehlerregistrierung und -verwaltung sowie zur Bearbeitung von Funktionsanforderungen. Sie können sich bei Bugzilla mit Persona anmelden. Wenn Sie einen relevanten Fehler gefunden haben, sollten Sie den Fehler kommentieren, der Ihr Interesse an der Behebung des Fehlers zeigt.

Sie können auch um Hilfe beim Suchen einer bestimmten Datei im Quellcode bitten, in der der Fehler vorhanden ist, von den Entwicklern im Mozilla-IRC. Sie sind eine wirklich freundliche Gruppe von Menschen, die Ihnen gerne helfen, Ihren ersten Fehler zu beheben. Falls niemand online ist, versuchen Sie das Hinzufügen von a needinfoFlagge für den Mentor, der im Bug erwähnt wird, und er wird zurückkommen, um Ihnen zu helfen!

Änderungen im lokalen Repository speichern

Vorausgesetzt, Sie haben den Fehler behoben und die entsprechenden Änderungen in den Dateien lokal vorgenommen, müssen Sie die Dateien sehen, die mit dem Versionskontrollsystem lokal geändert wurden. Geben Sie einfach den folgenden Befehl in das ein Webmaker-Profil-2 Verzeichnis.

Git-Status

Daraufhin werden die Details der modifizierten Dateien sowie neue Dateien angezeigt, die dem lokalen Repository hinzugefügt wurden. Wenn Sie mit den geänderten Dateien zufrieden sind, fügen Sie die geänderten / neuen Dateien zum Staging-Bereich hinzu.

git add names_of_files

Wenn alles gut läuft, können Sie die Dateien sicher übergeben.

git commit -m "Ihre Nachricht hier"

Commit-Protokoll säubern und Änderungen übernehmen

Stellen Sie sicher, dass Ihr Commit keine unnötigen Leerzeichen oder neuen Zeilen enthält. Es wird als eine gute Praxis betrachtet, die Nachricht in etwa "Fixing Bug 1040556" zu nennen. Aus Gründen, die ich Ihnen später in diesem Artikel erläutern werde. Die Betreuer des Repositorys ziehen es vor, wenn Sie eine einzige Commit-Anforderung pro Pull-Anforderung haben. Wenn Sie also mehr als ein Commit lokal haben, sollten Sie diese neu definieren.

Git Rebase -i KOPF ~ 2

Der obige Befehl setzt voraus, dass Sie zwei Commits haben und -ich ist die Flagge für interaktives Umbasieren. Es zeigt die beiden Commits zusammen mit ihren Botschaften, die das Wort haben auswählen vorangestellt. Einfach austauschen auswählen mit quetschen bei einem der Commits und Sie sind gut zu gehen. Im nächsten Bildschirm werden die Commit-Nachrichten nur zusammengedrückt. 

Glückwunsch, Sie haben die Commits erfolgreich umbasiert. Jetzt müssen Sie nur noch die Änderungen in Ihr GitHub-Repository übernehmen.

git Push

Wenn Sie den ersten Commit bereits ausgeführt und anschließend erneut basiert haben, versuchen Sie den folgenden Befehl.

git push -f

Pull-Request öffnen

Öffnen Sie nun Ihr Online-Repository und klicken Sie auf die Schaltfläche für Pull-Anfragen und öffnen Sie eine neue Pull-Anfrage.

Es füllt automatisch den Titel der Pull-Anfrage aus der Festschreibungsnachricht und zeigt den Diff (die folgende Abbildung zeigt den Diff für meine Pull-Anfrage).

Herzlichen Glückwunsch, Sie haben Ihre erste Pull-Anfrage gemacht. Aber Sie müssen noch ein paar Dinge tun. Kopieren Sie die URL Ihrer Pull-Anfrage und öffnen Sie Ihren Fehler in Bugzilla. Wählen Fügen Sie einen Anhang hinzu und fügen Sie dort die URL der Pull-Anfrage ein. Aktivieren Sie das Kontrollkästchen "Patch" und fügen Sie ein Überprüfungsflag für Ihren Mentor hinzu.

Wenn Ihr Patch korrekt war, führt Ihr Mentor Ihre Pull-Anforderung in das Haupt-Repository ein, und der Fehler wird vom Github-Roboter von Bugzilla automatisch behoben (dies geschieht nur, wenn der Commit- und Pull-Request-Name die Fehlernummer enthält)..

Es gibt nichts Schöneres, als zu sehen, wie Ihr Code in die Hauptcodebasis eingefügt und auf der von Millionen von Benutzern verwendeten Hauptwebsite bereitgestellt wird!

Ich hoffe, Sie konnten die Schritte befolgen, um Ihren ersten Fehler bei Webmaker oder ein ähnliches Open-Source-Projekt zu beheben.