Open-Source-Etikette
Wenn Sie noch nie an einem Open-Source-Projekt (OSP) gearbeitet haben, ist es eine gute Idee, diesen Artikel zu lesen, bevor Sie beginnen, zu den MDN Web Docs und anderen Open-Source-Projekten beizutragen. Es gibt einige Verhaltensweisen, die Sie annehmen sollten, um sicherzustellen, dass Sie und die anderen Projektmitwirkenden sich wertgeschätzt und sicher fühlen und produktiv bleiben. Dieser Artikel wird Ihnen nicht alles darüber beibringen, wie man zu Open Source beiträgt; das Ziel ist es, grundlegende Themen für die Teilnahme an Open-Source-Gemeinschaften abzudecken.
Überlegen Sie, warum Sie zu einem OSP beitragen
Bevor Sie beginnen, zu einem Open-Source-Projekt beizutragen, fragen Sie sich, warum Sie das tun möchten. Es ist in Ordnung, wenn die Antwort auf diese Frage lautet, "Ich möchte etwas mit meiner Zeit anfangen", aber noch bessere Gründe könnten sein:
- Ich möchte meine Fähigkeiten verbessern.
- Ich benutze dieses Werkzeug ständig und habe einen Fehler darin gefunden oder möchte helfen, es zu verbessern.
- Ich möchte anderen Menschen helfen, das Werkzeug erfolgreicher zu nutzen.
- Ich möchte anderen Menschen helfen, erfolgreicher zum Projekt beizutragen.
- Ich möchte meine eigenen Fähigkeiten öffentlich für meinen Hochschulkurs demonstrieren oder meine Chancen auf einen Job verbessern.
Einige dieser Gründe sind egoistisch, und das ist in Ordnung! Eine klare Reihe von Gründen für das Beitragen wird Sie produktiver machen und es einfacher machen, mit der Gemeinschaft zusammenzuarbeiten.
Seien Sie höflich, seien Sie nett, vermeiden Sie entzündliche oder beleidigende Sprache
Wir könnten dies auf "Seien Sie nett" verkürzen. Dies ist unser wichtigster Ratschlag für alle, die mit Open-Source-Beiträgen beginnen. Seien Sie nett zu den anderen Mitwirkenden im Projekt, und es wird ein glücklicherer und produktiverer Ort sein.
- Danken Sie Menschen, wenn sie Ihnen helfen.
- Gratulieren Sie Menschen, wo es angemessen ist, zum Beispiel wenn sie einen Pull Request abschließen oder einen schwierigen Fehler beheben.
- Antworten Sie immer respektvoll, selbst wenn Sie das Gefühl haben, dass die Antwort auf eine Frage offensichtlich war oder dass sich jemand wiederholt.
- Versuchen Sie, Menschen zu helfen, besser zu werden, in einer unterstützenden Weise. Zum Beispiel ist es nicht so hilfreich zu sagen "Das ist falsch" oder "Hier ist die Antwort", sondern zu sagen: "Dies ist in Ordnung, aber ich denke, es wäre besser, wenn wir es mehr so machen würden, hier ist ein Blogbeitrag für weitere Ideen" oder "Sie können die Antwort hier finden; schauen Sie sich auch diesen Link für weitere häufige Antworten an".
Mitwirkende sind hier, weil sie einen positiven Einfluss auf das Projekt haben möchten. Darüber hinaus sollten Sie keine Annahmen treffen, wie z.B.:
- Wissen über das Projekt und die verwendeten Technologien
- Geschlecht, Sexualität, Alter, gesprochene Sprachen, Standort, politische Ansichten, Religion oder andere persönliche Merkmale
- Erfahrung mit Open-Source-Projekten
- Selbstvertrauen
- Erwartungen
- Sinn für Humor
Sie sollten darauf achten, was Sie schreiben und kontroverse Themen wie Religion oder Politik vermeiden. Verzichten Sie auf Flüche oder möglicherweise beleidigende Sprache. Sie verbessert selten die Kommunikation und kann es anderen erschweren, teilzunehmen.
Seien Sie unterstützend und respektvoll, auch wenn Sie mit jemandem nicht einig sind oder eine Entscheidung, die sie getroffen haben, nicht mögen. Seien Sie sich bewusst, dass es in jedem guten OSP Regeln gibt, um seine Mitwirkenden davor zu schützen, sich beim Beitragen unwohl zu fühlen. Diese finden sich normalerweise in einer CODE_OF_CONDUCT.md
-Datei auf GitHub (siehe mdn/content
CODE_OF_CONDUCT als Beispiel).
Die Repositories von MDN werden durch die umfassenden Mozilla Community Participation Guidelines (CPG) geregelt. Typischerweise wird bei leicht anstößigem Verhalten in MDN Web Docs-Repos (wie das ständige Abschweifen vom Thema/Stören oder Unhöflichkeit) zuerst mit einer Warnung und danach mit einer endgültigen Warnung reagiert, gefolgt von einem temporären oder permanenten Bann. Schwerwiegendere Verhaltensprobleme wie Hassrede oder Drohungen gegen einen anderen Mitwirkenden werden nicht toleriert und werden wahrscheinlich zu einem sofortigen Bann führen.
Wenn Sie etwas erhalten, das Sie unangenehm finden, sollten Sie es immer über den im Verhaltenskodex vorgesehenen Mechanismus melden.
Wählen Sie effektive Beiträge
Denken Sie darüber nach, was Sie im Projekt machen möchten. Zum Beispiel haben wir eine große Liste von Problemen, die im Contributors Task Board aufgelistet sind, aufgeschlüsselt nach verschiedenen Aufgabentypen. Sie könnten auch durch das Öffnen von Pull Requests beitragen, um Probleme zu beheben, auf die Sie stoßen, während Sie MDN-Artikel lesen.
Ein Großteil der Arbeit bei MDN dreht sich um das Schreiben von Dokumentationen und Codebeispielen, aber es gibt auch andere Möglichkeiten beizutragen. Dies könnte das Sortieren von eingehenden Problemen sein, das Beheben von Tippfehlern, die Korrektur von Grammatik, um Seiten verständlicher zu machen, oder das Mentoring von Personen, die versuchen, Korrekturen vorzunehmen. Jede Korrektur ist nützlich, egal wie klein, und wir werden keine ablehnen. Dennoch sollten Sie versuchen, sicherzustellen, dass Ihre Korrekturen produktiv sind. Wir möchten von folgenden Arten von Beiträgen abraten:
- Den Code-Stil, die Sprache in der Prosa oder das Testframework zu aktualisieren, nur weil Sie es besser mögen.
- Seiten von US-Englisch auf Britisches Englisch zu ändern.
- Hinzufügen oder Entfernen von Satzzeichen, wenn das Original korrekt ist.
In vielen Fällen sind die Dinge in OSPs aus einem bestimmten Grund so, wie sie sind. Sie sollten Stilrichtlinien lesen, wenn solche vorhanden sind, und wenn Sie Zweifel darüber haben, ob etwas produktiv ist, fragen Sie immer zuerst!
Lesen Sie das Handbuch
Gute OSPs stellen die Dokumentation für Mitwirkende immer leicht zugänglich zur Verfügung. Bei GitHub-Projekten befindet es sich normalerweise in der CONTRIBUTING.md
-Datei des Repos oder manchmal in der README.md
-Datei des Projekts. Als Dokumentationsprojekt hat MDN-Inhalt ein README und eine ordentliche Sammlung von Mitwirkendendokumentationen auf der Website selbst (siehe Community-Ressourcen).
Haben Sie keine Angst, um Hilfe zu bitten, aber versuchen Sie immer zuerst, die Antwort auf Ihre Frage zu finden, bevor Sie fragen. Auf diese Weise bauen Sie Ihr Wissen über das Projekt auf und werden unabhängiger, und belasten nicht unnötig die anderen Mitwirkenden. Wenn eine Erklärung schwer zu finden oder nicht gut beschrieben ist, öffnen Sie ein Problem oder erstellen Sie einen Pull Request, um es selbst zu beheben.
Finden Sie heraus, wo man Fragen stellt
Finden Sie heraus, wo der beste Ort ist, um Fragen zu stellen. Gute OSPs machen dies immer in ihrer Dokumentation klar (siehe Kontakt aufnehmen). Wenn Sie allgemeine Fragen stellen wollen, dann nutzen Sie immer diese Kanäle. Öffnen Sie nicht für jede Frage ein Problem auf GitHub, da es das Projekt mit Lärm überzieht (siehe den nächsten Abschnitt).
Machen Sie Fortschritte, nicht Lärm
Denken Sie sorgfältig darüber nach, wie Sie die Kommunikation im Projekt handhaben – stellen Sie sicher, dass sie nützlich ist und die Arbeit anderer Mitwirkender nicht erschwert. Pull Requests einzureichen, um Fehler zu beheben, ist großartig, aber stellen Sie sicher, dass sie nützlich oder einfach zu überprüfen sind. Probleme zu melden und an anderen Gesprächen teilzunehmen, ist in Ordnung, aber sind Ihre Probleme und Kommentare themenbezogen, oder verursachen sie Lärm?
Generell gilt:
- Diskutieren Sie ein Thema pro Problem – es ist einfach, Probleme fokussiert und produktiv zu halten.
- Beheben Sie ein Problem pro PR – es mag für Sie etwas mehr Arbeit sein, aber es ist viel einfacher, eine einzelne klare Korrektur zu überprüfen.
- Tragen Sie zu anderen Threads bei, wenn Sie einen nützlichen Punkt einbringen oder jemandes Frage beantworten können.
- Stellen Sie Fragen mit anderen Mechanismen wie Chatrooms oder Foren, wenn Sie sich nicht sicher sind, ob etwas nützlich ist oder Sie eine einfache Frage haben.
- Lesen Sie das Handbuch zuerst, um zu versuchen, die Frage selbst zu beantworten, bevor Sie sie stellen.
Nicht tun:
- Komplexe Probleme schaffen, indem Sie versuchen, mehrere Themen auf einmal zu diskutieren oder themenfremde Kommentare abzugeben.
- Versuchen Sie nicht, mehrere Korrekturen in eine einzige Pull-Anfrage zu packen. Es wird viel schwieriger zu überprüfen und weckt Verdacht (einige Leute könnten denken, Sie versuchen, bösartigen Code zwischen den gültigen Änderungen zu verstecken).
- Öffnen Sie nicht viele Probleme mit vagen Fragen.
- Stellen Sie keine Fragen, ohne zuerst zu versuchen, das Problem selbst zu lösen.
OSPs sind eine Demokratie (fast)
OSPs sind ziemlich demokratisch - viele Entscheidungen werden abgestimmt, und Sie sind weitgehend frei, wie Sie beitragen möchten, solange Sie niemanden daran hindern, ebenfalls beizutragen.
Allerdings werden einige Dinge weitgehend von einer kleinen Gruppe von Kernmitwirkenden entschieden. Sie sind frei, gegen jede Entscheidung Stellung zu beziehen, aber manchmal wird ein Moderator eine Entscheidung treffen, die gegen Ihre Meinung geht. Sie müssen diese Entscheidungen respektieren und akzeptieren.
Es ist nützlich, die Moderatoren eines Projekts kennenzulernen, damit Sie wissen, an wen Sie sich am besten um Hilfe wenden können, zum Beispiel in Pull Requests oder Problem-Threads.
Seien Sie geduldig, seien Sie zeitnah
Denken Sie daran, dass viele Menschen, die an OSPs arbeiten, dies in ihrer Freizeit ohne Bezahlung tun, und alle Menschen, die an OSPs arbeiten, sind in der Regel sehr beschäftigt. Wenn Sie auf etwas warten, wie z.B. eine Überprüfung des Pull Requests oder eine Antwort auf eine Frage, seien Sie geduldig.
Es ist vernünftig, ein paar Tage zu warten und dann jemand höflich zu fragen, ob er Zeit hatte, es sich anzusehen. Wenn sie zu beschäftigt sind, ist es am besten, eine weitere Woche zu warten und dann erneut nachzufassen.
Es ist nicht vernünftig oder höflich, Dinge wie eine schnelle Antwort zu verlangen.
Wenn jemand darauf wartet, dass Sie etwas für ihn tun, sollte Ihnen die gleiche Höflichkeit entgegengebracht werden, aber gleichzeitig versuchen Sie, so schnell wie möglich zu antworten. Wenn Sie wirklich keine Zeit finden können, lassen Sie es sie wissen und bitten Sie die Betreuer, Ihnen zu helfen, jemand anderen für die Aufgabe zu finden.