Wie Sie dazu Beitragen, eine Open-Source-Projekt

0
7

Im folgenden wird etwas rechthaberisch und Ziele zu führen, jemanden auf Ihrer Reise ins open source. Als Voraussetzung sollten Sie über grundlegende Vertrautheit mit der Kommandozeile und Git. Wenn Sie wissen, die Konzepte und die wollen, Tauchen Sie ein in die Schritt für Schritt Anleitung, Lesen Sie in diesem Teil des Artikels.

Wirklich, es gibt keine eine Möglichkeit, einen Beitrag zu einer open-source-Projekt und beteiligt zu werden bedeutet oft mehr als code anschlagen. In diesem Artikel, obwohl, konzentrieren wir uns auf die nitty-gritty der Beitrag einen pull request (PR) jemand anderes das Projekt auf GitHub.

Lassen Sie uns die Bühne…

Sie stoßen jemandem das Projekt auf Github und Sie lieben es! Sie können sich sogar entscheiden, um es in Ihr eigenes Projekt. Aber es gibt eine kleine Sache, die Sie bemerken… es könnte ein Fehler sein. Könnte es eine Verbesserung, was bereits vorhanden ist. Vielleicht haben Sie sah durch den code, und fand eine schöne, optimierte Art und Weise zu schreiben, Dinge, die ein wenig mehr lesbar, sogar so klein wie eine extra Vertiefung in dem code.

Hier sind einige erste Vorschläge und Anweisungen, wohin Sie gehen von hier aus.

Suchen für einen BEITRAG.md-Dokument oder Beitrag Anleitung in der Dokumentation

Viele open-source-Projekte, wissen, dass andere Menschen einbringen wollen. Wenn Sie finden, sich der Beantwortung der gleichen Frage wieder und wieder, dieses Dokument beabsichtigt, um es einfacher zu bekommen, alle auf der gleichen Seite.

Einige Dinge, die Sie vielleicht zu finden in einem Beitrag guide:

  • Stil-Richtlinien
  • Voraussetzungen für die Einreichung einer PR
  • Wie Sie Ihren ändern, um Ihre Dokumentation
  • Eine Checkliste für den Beitrag
  • Zu erklären, das Projekt, seine Architektur und Einrichtung

Dieses Dokument kann so einfach wie ein paar Notizen, oder es kann so robust sein, dass es dauert eine kleine Weile durch zu Lesen, die alle (wie der Atom-Beitrag-Handbuch, zum Beispiel).

Für größere Projekte macht es Sinn, zu kommunizieren Beitrag Leitlinien vorne, weil PRs und die Probleme häufen sich an und werden eine echte ziehen Sie auf eines Betreuers ist an der Zeit, Sortierung durch Beiträge, die möglicherweise aus dem Projekt-Bereich. Stellen Sie sicher, nehmen Sie einige Ihrer eigenen Zeit mit dem Lesen durch diese Anleitung, wenn es existiert, weil Ihre PR benötigen einige von den wartenden die Zeit als auch.

Schauen Sie durch die vorhandenen Fragen und PRs

Vor dem hinzufügen einer neuen Ausgabe oder zum Einreichen der PR, es ist gut, zu überprüfen, was es sonst noch gibt. Finden Sie vielleicht jemand hat schon fragte über die gleiche Sache, eingereicht oder etwas ähnliches. Können Sie in den Projekt-Suchfeld — ich in der Regel Suche über Themen, die beide offen und geschlossen, denn es ist wichtig zu wissen, ob schon jemand hob mein Anliegen und vielleicht auch die Betreuer beschlossen, in eine andere Richtung gehen. Nochmal, es geht darum, sparen sowohl Sie als auch der Betreuer Zeit.

Senden Sie eine Frage

Einreichen von Fragen ist ein zentraler Bestandteil der PR-Vorlage Prozess. Sie bieten die Gelegenheit, zu artikulieren, die situation, schaffen Kontext um ihn herum, und ein forum für Diskussion, die angebracht werden können um die PR selbst.

Bei der Einreichung ein Problem, ich mag zu schreiben, was mein Anliegen ist und dann wieder Lesen Sie wie, wenn ich war auf der Empfängerseite. Menschen sind Menschen — auch wenn das, was Sie sagen ist technisch korrekt, sind Sie wahrscheinlich nicht zu bekommen buy-in für Ihre Idee, wenn Ihr Ton ist off-putting. Beachten Sie dies: Sie Fragen sich jetzt vielleicht, für jemanden zu tun, eine Menge Arbeit in Ihrer Freizeit. Wenn jemand Sie fragt, arbeiten Sie an einem Samstag, sind Sie eher zu tun, so dass, wenn Sie bitten, respektvoll mit Herablassung? Sie erhalten das Bild.

Bei der Einreichung ein Problem, stellen Sie sicher, Sie geben Ihnen alle details, die Sie benötigen, um die Arbeit zu erledigen. Einige Dinge, die Sie vielleicht beachten:

  • Wenn es ein bug ist, dann in welcher Umgebung Sie sehen das problem? Ist es Entwicklung oder Produktion? Vielleicht irgendwo anders?
  • Wenn es ein feature-request, dann erklären Sie das problem. Manchmal framing diese aus der Perspektive der Endbenutzer in form von user stories kann hilfreich sein, sowohl zu konzipieren, die situation und Abstrakt und es aus der persönlichen Gefühle.
  • Wenn es eine Allgemeine Frage, dann erklären, dass Sie es nach vorn, so der maintainer kann vermeiden Sie verbringen Zeit versucht, herauszufinden, wenn Sie Fragen, für ein bug ist oder ein feature.
  • Wenn Sie möchten, senden Sie eine PR zu verbessern, auf die Frage, erwähnen, dass Sie möchten, dies zu tun, dann Fragen Sie um Erlaubnis, um fortzufahren (denn manchmal maintainer haben andere Elemente vorgesehen, die Sie nicht einschätzen können).

Überlegungen vor Beginn der arbeiten

Wahrscheinlich sind Sie begierig zu Beginn der Arbeit auf Ihre PR durch diesen Punkt. Aber zuerst gibt es noch ein paar üblichen Dinge zu prüfen, bevor Sie Graben in.

Zuerst Fragen

Ich bin ein großer fan von Leuten gefragt werden, in ein Problem, wenn die PR macht Sinn, bevor Sie arbeiten auf einem. Ich glaube nicht, halten Sie es als eine strenge Regel, aber manchmal kann ich Sie retten Eimer Zeit und geht in die falsche Richtung, wenn wir klären, was wir beide wollen zusammen den ersten. Es hilft auch, andere wissen nicht implementieren die gleiche Sache (vorausgesetzt, Sie, zu, Blick durch offene und geschlossene PRs.

Verwenden Sie Etiketten, die

Wenn Sie senden ein Problem, und jeder stimmt ein PR ist eine gute Idee, dann ist es schön für Sie (oder der Besitzer des repo), fügen Sie die label-in-progress. Sie können suchen, Beschriftungen, damit es wirklich jedem klar, Sie arbeiten dran.

Arbeit in kleinen Blöcken!

Als ein Betreuer, ist es frustrierend, wenn jemand in eine Menge Arbeit und legt einen riesigen Hupen PR, die nicht 10 verschiedene Dinge. Es ist wirklich schwer zu überprüfen, und unvermeidlich, Sie tun sechs Dinge, die Sie wollen, und vier Dinge, die Sie nicht. Nicht nur das, es ist in der Regel verteilt auf mehrere Dateien, die schwer zu entwirren. Ich habe auf jeden Fall geschlossen PRs mit einigen qualitativ hochwertigen code, den ich möchte, nur weil es würde ewig dauern für Sie zu überprüfen und zu verwalten. (Ich werde kommunizieren, dass dies die Frage, ob Sie möchten, um Sie erneut der Arbeit als getrennte, PRs, though.)

Meiner Meinung nach, Sie haben etwa 1000% mehr chance, Ihre PR-zusammengeführt und Ihre Zeit, die Sie geehrt, wenn Sie teilen Dinge, die über mehrere, kleinere PRs. Ich Liebe es, wenn Menschen senden Sie eine PR pro Thema. Und es kann nett sein, Bedarf es nicht, wenn jeder eingereichte Beitrag ist ein wenig ausgeflippt, als auch, um mit Hilfe der kognitiven überlastung.

Senden Sie Ihre PR

Dies sind die Schritte, die ich persönlich verwenden, um einen PR Einreichen. Sie können dies andere Möglichkeiten, natürlich, aber ich habe Folgendes gefunden, um wirksam zu sein, in meine Erfahrungen. Auch, etwas in die Befehle sind in Großbuchstaben geschrieben ist, Informationen, die Sie benötigen, um änderungen, die für Ihre Verwendung.

First off, gehen Sie zu dem repo-Geschäft, und Gabel, eine Kopie des Projekts auf Ihrer persönlichen GitHub-account. Klonen Sie Sie lokal, und ändern Sie das Verzeichnis (cd) zu, wo es sich befindet. (Ich HTTPS verwenden, aber SSH ist völlig in Ordnung als auch.)

git clone https://github.com/YOUR-USERNAME/YOUR-FORKED-REPO.git
cd in/geklont/Gabel-repo

Als Nächstes, fügen Sie ein remote-upstream, um den ursprünglichen Zweig. Dies bedeutet, es wird in teilen eine Verbindung mit dieser ursprünglichen Zweig, so dass Sie synchronisieren und ziehen Sie alle updates für das Projekt, wenn Sie geschehen.

git remote add upstream https://github.com/ORIGINAL-DEV-USERNAME/REPO-YOU-FORKED-FROM.git
git fetch upstream

Jetzt können Sie einen neuen Zweig, und geben Sie ihm einen Namen, bezieht sich auf das PR-Thema. Beachten Sie, dass ein Betreuer könnten eine bestimmte Namenskonvention Geist, der dokumentiert ist in dem repo.

git checkout -b GUT FORKIN-NAMEN

Gehen Sie weiter und arbeiten an Ihrer änderungen. Achten Sie darauf, gute commit-Nachrichten auf den Weg geben:

git add-A
git commit -m “HINZUFÜGEN, die IN EINEM TACO-SPENDER”
git push origin GUT FORKIN-NAMEN

GitHub werden sehen, die neue Gabel und fordert Sie auf, machen die PR, das ist eine nette, hilfsbereite touch. Sie klicken Sie auf die Schaltfläche und füllen Sie die details: welches Problem gilt es zu schließen? Sie können Sie durch Ihre Anzahl und GitHub wird automatisch zuordnen:

Auf der PR:

In der Ausgabe:

Was sind einige der Dinge zu beachten, in der PR? Diese Angaben helfen die Betreuer verstehen, Zusammenhang. Diese können alle änderungen, die Sie gemacht, Sie können eine größere Strategie oder Kontext.

Und Sie sind auf Ihrem Weg! 🎉

Sie können finden, die Sie benötigen, um Ihre Gabel up-to-date mit der Fernbedienung, und ziehen Sie Ihre änderungen in Ihnen. So zu tun, Sie würde diesen Befehl ausführen:

git pull upstream-master

Props an Christina Solana, für Ihre Kernaussage, die ich verwendet habe, als Referenz für Jahre und Jahre jetzt.

Denken Sie immer daran: die Betreuer sind oft überschwemmt, zu opfern Nächte und Wochenenden zu halten open-source-Projekten aktiv und aktualisiert. Sein respektvoll, sowohl in Bezug auf Ihre Zeit, und Sie in Ton, können Sie zum Erfolg beitragen.

Open source kann sehr lohnend! Das wissen anderer Menschen profitieren und direkt über etwas beigetragen werden kann, eine große Möglichkeit zu geben, zurück zu der Gemeinschaft und zu lernen.