Get best of the week

Open Source-Anleitungen: Starten eines Open Source-Projekts



Vorwort des Übersetzers


Vor ein paar Monaten bin ich auf Github auf den Link "Open Source Guides" gestoßen und konnte mich nicht lösen. Irgendwann in einer Woche habe ich alle 10 Abschnitte sorgfältig gelesen. Natürlich wusste ich bereits über Open Source Bescheid: Ich las verschiedene Artikel (zum Beispiel „Open Source verstehen“ ), verwendete solche Projekte in meiner Arbeit, richtete Fragen an Communities, meldete Fehler, durchsuchte Probleme und unternahm sogar ungeschickte Versuche dann zumindest die Dokumentation verbessern. Und natürlich war ich im Herzen mit diesen Leuten, die Software und Wissen über ihre Verwendung teilen. Das Konzept von Open Source war jedoch eher vage und fragmentarisch. Und dieser Artikel fügte Klarheit hinzu.

Darüber hinaus hatte ich einige Projekte, die ich in diesem Format starten wollte, in der Hoffnung auf Unterstützung durch die Community und mit vielen damit verbundenen Ängsten und Zweifeln. Auch dieser Artikel half mir, meine Absicht zu begründen und praktische Schritte vorzuschlagen.

Unabhängig von Ihrer Einstellung zu Open Source finden Sie in dieser Reihe von 10 Artikeln viele interessante Ideen und Fakten: organisatorische, psychologische, rechtliche, ethische und technische.

Ich habe diesen Nicht-Programmierer diesen Text lesen lassen, sie sagten, dass sie alles verstanden haben. Und im Titel des Artikels habe ich bewusst die „Quelle“ ohne den „Code“ eingefügt, da dieses Thema nicht nur für Programmierer relevant ist, sondern für fast jede intellektuelle Aktivität im Format eines offenen Projekts.

Dieses Handbuch selbst ist ebenfalls Open Source und wurde bereits in 14 Sprachen übersetzt. Es war mir eine Ehre, einen russischen Thread und eine Übersetzung des ersten Artikels hinzuzufügen. Ich plane, weiterhin Artikel pro Woche zu übersetzen. Wenn jemand eine Verbindung herstellen möchte, finden Sie hier das Repository: Open Source Guides .

Wenn plötzlich jemand einen Bildschirmschoner aus der Überschrift des Artikels benötigt (Abbildungen + russische Namen), dann ist er in einem Layout auf Codesandbox.io .

Auswahl der Begriffe


Ich entschuldige mich im Voraus für die Mängel in der Übersetzung. Einige scheinbar banale Begriffe sind auf Russisch nicht so einfach zu verstehen. Zum Beispiel, um einen Beitrag zu leisten, eine Anfrage zu ziehen oder ein Problem zu lösen, habe ich oft übersetzt: "Am Projekt teilnehmen, Korrekturen vorschlagen und eine Frage". Ich habe Open Source bisher auf Englisch verlassen. Ich habe bereits einen Kommentar abgegeben und einen Link zum Wörterbuch der Begriffe von Github gesendet . Die Fülle der Transliteration dort gefiel mir nicht. Wenn all diese Ishis, Pullrequest, Push, Pool, Fork im Artikel enthalten sind, wird dies für alle, die nicht mit Github gearbeitet haben, unverständlich.

Ja, das Problem kann eine Frage, eine Aufgabe, ein Fehlerbericht, ein Satz usw. sein, und es ist schwierig, ein russisches Wort zu finden, das all diese Bedeutungen vermittelt. Aber das englische Wort Problem hat auch keine besonders breite Bedeutung, nur die Schöpfer und Benutzer von Github haben es mit einer solchen Breite ausgestattet. Wenn wir mit den Worten "eine Frage auf Github öffnen" meinen, dass diese Frage sehr unterschiedlich sein kann (Fehler, Frage, Bitte um Hilfe, Aufgabe, ...), dann wird das Wort "Frage" das Wort "Problem" harmonisch ersetzen. Auch - Push - Send, Pull - Accept, Fork - Branch usw. Es ist nicht das Wort selbst, das zählt, sondern die Bedeutung, die wir vereinbart haben. Die Briten, die zuerst auf Github auf den Begriff stoßen, müssen im Rahmen dieses Systems zunächst eine Beschreibung aller möglichen Bedeutungen lesen.In der Zwischenzeit nehme ich Klarheit als Priorität für die maximale Anzahl von Personen, die nicht mit Github gearbeitet haben. In jedem Fall ist die Auswahl der Begriffe im Gange, und die gesamte Übersetzung ist wie das Original Open Source. Machen Sie also Pull-Quests und öffnen Sie mit ish.


: ?
«open source»?
?
Open source — ?

open source ?



open source

README






, ( ) !






: ?


Denken Sie darüber nach, Ihr Open Source-Projekt zu starten? Herzliche Glückwünsche! Die Welt schätzt Ihre Teilnahme. Lassen Sie uns darüber sprechen, was Open Source ist und warum die Leute es tun.

Was bedeutet Open Source?


Wenn der Projektcode geöffnet ist, kann jeder Ihr Projekt für jeden Zweck verwenden, studieren, ändern und verteilen. Diese Berechtigungen werden über eine Open Source-Lizenz erteilt .

Der Vorteil von Open Source besteht darin, dass es die Hindernisse für die Auswahl Ihres Programms und die Zusammenarbeit verringert und es den Mitarbeitern ermöglicht, Projekte schnell zu verteilen und zu verbessern. Darüber hinaus haben Benutzer die Möglichkeit, den Code zu steuern, anstatt ihn zu schließen. Ein Open-Source-Softwareunternehmen (Software) kann jemanden einstellen, der Verbesserungen an der Software vornimmt, anstatt sich ausschließlich auf die Entscheidung des Open-Source-Anbieters zu verlassen.

Freie Software bezieht sich auf die gleichen Projekte wieOpen Source Software (die Open Source) . Manchmal finden Sie Kombinationen dieser Begriffe : "Freie und Open-Source-Software" (freie und Open-Source-Software FOSS oder freie, libre und Open-Source-Software FLOSS). Die Worte befreien und libre hier mean „frei“ , nicht „frei . "

Warum machen Menschen ihre Arbeit offen?


BenutzerbildEine der größten Belohnungen, die ich von Open Source erhalten habe, ist die Beziehung, die zu anderen Entwicklern aufgebaut wurde, die mit denselben Problemen konfrontiert sind wie ich.
@ kentcdodds , "Wie großartig war es für mich, Open Source zu betreten "

Es gibt viele Gründe, warum eine Person oder Organisation die Quelle ihres Projekts öffnet. Hier sind einige davon:

  • : Open source . , Exercism, 350 .
  • : Open source , . -. WordPress, , b2.
  • Transparenz: Jeder kann ein Open Source-Projekt auf Fehler und Inkonsistenzen überprüfen. Transparenz ist auch auf staatlicher Ebene wichtig. Zum Beispiel haben die bulgarische Regierung und die Vereinigten Staaten Transparenz für Branchen wie Banken, Gesundheitswesen und Sicherheitssoftware wie Let's Encrypt gesetzlich geregelt .

Open Source gilt nicht nur für Software, sondern für alles andere: von Datensätzen bis zu Büchern. Im GitHub Review erhalten Sie weitere Ideen, was überempfindlich sein kann.

Ist Open Source kostenlos?


Free Open Source ist einer der größten Vorteile, aber nicht der einzige, sondern ein Nebenprodukt seines kombinierten Werts.

Da eine offene Lizenz impliziert, dass jeder Ihr Projekt für fast jeden Zweck verwenden, ändern und vertreiben kann, bedeutet dies in den meisten Fällen, dass dies kostenlos ist. Denn wenn Sie eine Gebühr verlangen würden, würden die Leute das Projekt herunterladen und es absolut legal kostenlos nutzen.

Daher sind die meisten Open Source-Projekte kostenlos, dies ist jedoch nicht in der Definition von Open Source enthalten. Es gibt Möglichkeiten, Open Source-Projekte indirekt durch doppelte Lizenzierung oder eingeschränkte Funktionen zu belasten, sie entsprechen jedoch der offiziellen Definition von Open Source.

Soll ich mein Open Source-Projekt starten?


Die kurze Antwort lautet Ja, denn unabhängig vom Ergebnis ist das Starten Ihres Projekts ein guter Weg, um zu verstehen, wie Open Source funktioniert.

Wenn Sie solche Projekte noch nie durchgeführt haben, könnten Sie sich Sorgen machen: "Was werden die Leute sagen?", "Was ist, wenn ihn niemand bemerkt?" Wenn Ihnen das bekannt ist, machen Sie sich keine Sorgen, Sie sind nicht der einzige!

Open Source sorgt wie jede kreative Arbeit, sei es Schreiben oder Zeichnen, für Aufregung, bevor sie mit der Welt geteilt wird. Die einzige Möglichkeit, dies zu verbessern, besteht darin, zu üben, auch wenn Sie kein Publikum haben.

Wenn Sie sich noch nicht entschieden haben, nehmen Sie sich Zeit, um über Ihre möglichen Ziele nachzudenken.

Ziele setzen


Ziele helfen Ihnen bei der Entscheidung, woran Sie arbeiten, was Sie aufgeben und wo Sie Hilfe von außen benötigen. Fragen Sie sich: "Warum öffne ich dieses Projekt?" .

Es gibt keine einheitliche Antwort auf diese Frage. Sie können viele Ziele für ein Projekt oder verschiedene Projekte mit unterschiedlichen Zielen haben.

Wenn Ihr Ziel einfach darin besteht, Ihre Arbeit zu zeigen und keine Zusammenarbeit erforderlich ist, können Sie in die README-Datei schreiben. Wenn Sie sich jedoch für Assistenten interessieren, sollten Sie Ihre Zeit in das Schreiben verständlicher Unterlagen investieren und sich um Anfänger kümmern.
Benutzerbild UIAlertView … open source. GitHub. , , . , - . .
mavris@mavris, « : Open Source »

Wenn das Projekt wächst, benötigt Ihre Community mehr als nur Code. Antworten auf Fragen (Probleme), Codeüberprüfung, Verbreitung von Informationen über sich selbst - all dies sind wichtige Aufgaben eines Open-Source-Projekts.

Obwohl der Zeitaufwand für nicht programmatische Aufgaben von der Größe und dem Umfang Ihres Projekts abhängt, sollten Sie darauf vorbereitet sein, diese selbst zu lösen oder einen Assistenten dafür zu finden.

Wenn Sie Teil eines Unternehmens sind, das ein Open Source-Projekt startet, stellen Sie im Voraus sicher, dass Sie über interne Ressourcen für dessen Entwicklung verfügen. Weisen Sie einen Support-Beauftragten nach dem Start zu und legen Sie fest, wie die Aufgaben innerhalb der Community verteilt werden.

Wenn Sie ein spezielles Budget oder Personal benötigen, um das Projekt voranzutreiben, zu betreiben und zu unterstützen, besprechen Sie dies so bald wie möglich.
BenutzerbildWenn Sie ein Open Source-Projekt starten, ist es wichtig, dass die Verwaltungsprozesse in der Organisation den Beitrag und die Fähigkeiten der Community berücksichtigen, die sich um das Projekt herum gebildet hat. Haben Sie keine Angst, Außenstehende einzubeziehen, auch in wichtigen Aspekten, insbesondere wenn sie aktiv beteiligt sind.
@captainsafia , "Che, möchten Sie den Projektcode öffnen?"

Teilnahme an Projekten anderer Leute


Wenn Sie verstehen möchten, wie Sie mit anderen interagieren und wie Open Source funktioniert, sollten Sie an einem bestehenden Projekt teilnehmen, das Sie verwenden und lieben. Ihre Teilnahme kann so einfach sein wie Tippfehler und Dokumentationsaktualisierungen.

Wenn Sie nicht verstehen, wie Sie an einem anderen Projekt teilnehmen können, lesen Sie unseren Leitfaden zur Teilnahme an einem Open Source-Projekt .

Starten Sie Ihr eigenes Open Source-Projekt


Es gibt keinen perfekten Moment, um die Quelle Ihrer Arbeit zu öffnen. Sie können sie in der Ideenphase, während des Arbeitsprozesses oder nach mehreren Jahren der Schließung öffnen.

Im Allgemeinen können Sie Open Source verwenden, wenn Sie sich sicher genug fühlen, Ihre Arbeit Fremden zu zeigen und deren Feedback zu erhalten.

Unabhängig von der Phase, in der Sie die Quelle geöffnet haben, sollte für jedes Projekt die folgende Dokumentation vorhanden sein:


Sie helfen Ihnen dabei, Ihre Erwartungen zu vermitteln, die Änderungen anderer Teilnehmer zu akzeptieren und die legitimen Rechte aller Mitautoren, einschließlich Ihrer selbst, zu schützen. Dies erhöht die Wahrscheinlichkeit einer positiven Erfahrung erheblich.

Wenn sich Ihr Projekt auf einem Github befindet und Sie diese Dateien mit empfohlenen Namen in die Stammkategorie einfügen, erkennt der Github sie und zeigt sie Ihren Lesern automatisch an.

Lizenzauswahl


Eine Open Source-Lizenz stellt sicher, dass andere Ihr Projekt ohne Konsequenzen verwenden, kopieren, ändern und ändern können. Es schützt Sie auch vor unangenehmen rechtlichen Situationen. Sie müssen die Lizenz aktivieren, wenn Sie ein Open Source-Projekt starten.

Juristische Arbeit ist nicht einfach. Aber es gibt gute Nachrichten: Sie können eine vorhandene Lizenz kopieren und in Ihrem Repository ablegen, um Ihre harte Arbeit in einer Minute zu schützen.

MIT , Apache 2.0 und GPLv3 sind die beliebtesten Lizenzen, es stehen jedoch auch andere Optionen zur Auswahl.

Wenn Sie ein neues Projekt auf Github erstellen, haben Sie die Wahl zwischen mehreren Lizenzen. Durch Auswahl einer Open Source-Lizenz öffnen Sie Ihr Projekt.

Wählen Sie eine Lizenz

Wenn Sie weitere Fragen oder Bedenken zu den rechtlichen Aspekten von Open Source haben, haben wir diese hier beschrieben .

Zusammenstellung von README


In der README-Datei („read me“) wird nicht nur erklärt, wie Sie Ihr Projekt verwenden, sondern auch, warum es wichtig ist und was Benutzer damit tun können.

Versuchen Sie, die folgenden Fragen in README zu beantworten:

  • Was macht dieses Projekt?
  • Wie ist dieses Projekt nützlich?
  • Wie kann ich mit ihm arbeiten?
  • Wo kann ich bei Bedarf Hilfe bekommen?

In README können Sie angeben, wie Sie an Ihrem Projekt teilnehmen möchten, welche Ziele es verfolgt, wie Sie über die Lizenz und die Urheberschaft sprechen. Wenn Sie nicht vorhaben, die Verbesserungen anderer zu akzeptieren, oder wenn er noch nicht bereit ist, zu rennen, schreiben Sie einfach darüber.
BenutzerbildGute Dokumentation bedeutet mehr Benutzer, weniger Hilfeanfragen und mehr Mitarbeiter. (...) Denken Sie daran, dass Ihre Benutzer nicht Sie sind. Dies können Menschen mit Erfahrung sein - ganz anders als Ihre.
@tracymakes , "Schreiben Sie, damit Ihre Wörter gelesen werden (Video)"

Manchmal verschieben Leute das Schreiben von README, weil sie das Gefühl haben, dass das Projekt nicht abgeschlossen ist oder die Verbesserungen anderer Leute nicht akzeptieren wollen. Dies ist jedoch nur ein guter Grund, darüber zu schreiben.

Als Inspiration können Sie den Leitfaden „README erstellen“ oder die README-Vorlage lesen .

Wenn Sie die README-Datei zum Stammverzeichnis des Projekts hinzufügen, zeigt der Github sie automatisch auf der Repository-Hauptseite an.

Schreiben eines Leitfadens für die Teilnehmer


Die CONTRIBUTING-Datei teilt Ihrem Publikum mit, wie Sie Mitglied Ihres Projekts werden können. Zum Beispiel:


Neben den technischen Details ist die CONTRIBUTING-Datei ein guter Ort, um Ihre Erwartungen hinsichtlich der Teilnahme anderer Personen darzulegen. Zum Beispiel:

  • Auf welche Art von Teilnahme warten Sie?
  • Ihre Pläne und Visionen für die Entwicklung des Projekts
  • Wie Teilnehmer Sie kontaktieren können (und nicht)

Ihr herzlicher, freundlicher Ton und Ihre konkreten Vorschläge zur Teilnahme, wie das Schreiben von Dokumentationen oder das Erstellen einer Website, können von großer Bedeutung sein, um Neulinge für die Arbeit an einem Projekt zu gewinnen.

Zum Beispiel beginnt Active Admin seinen Leitfaden zur Teilnahme mit folgenden Worten:
Zunächst möchten wir uns bei Ihnen dafür bedanken, dass Sie über eine Teilnahme an der Entwicklung von Active Admin nachgedacht haben. Es sind Menschen wie Sie, die Active Admin zu einem großartigen Werkzeug machen.

In der Anfangsphase eines Projekts kann Ihre CONTRIBUTING-Datei einfach sein. Sie sollten immer erklären, wie Fehler gemeldet und Fragen ausgefüllt werden, sowie die technischen Anforderungen für das Bearbeiten von Mitgliedern (z. B. Tests) beschreiben.

Im Laufe der Zeit können Sie es mit Antworten auf häufig gestellte Fragen ergänzen. Aus diesem Grund werden weniger Leute Sie immer und immer wieder das Gleiche fragen.

Um das Kompilieren einer CONTRIBUTING-Datei zu vereinfachen, lesen Sie die Vorlage für den Kollaborationsleitfaden von @ nayafia oderMozilla's "So kompilieren Sie die Datei CONTRIBUTING.md" .

Verknüpfen Sie die CONTRIBUTING-Datei in der README-Datei, damit mehr Benutzer sie sehen können. Wenn Sie die Datei CONTRIBUTING.md im Stammverzeichnis Ihres Projekts ablegen, verweist der Github automatisch darauf, wenn jemand eine neue Frage öffnet (Problem) oder dem Projekt eine Bearbeitung hinzufügt (Pull-Anfrage).

Leitfaden für die Zusammenarbeit

Entwicklung eines Verhaltenskodex


BenutzerbildWir alle sahen uns unangenehmen Situationen gegenüber, in denen der Projektbesitzer etwas grob erklärte oder Benutzer grundlegende Fragen stellten. (...) Ein Verhaltenskodex wird zu einem Dokument, auf das leicht Bezug genommen werden kann und das besagt, dass Ihr Team einen konstruktiven Dialog sehr ernst nimmt.
@mlynch , Open Source glücklicher machen

Infolgedessen legt der Verhaltenskodex die grundlegenden Verhaltensregeln für die Teilnehmer Ihres Projekts fest. Dies ist besonders wichtig, wenn Sie ein Projekt für ein Unternehmen oder eine Community starten. Ein Verhaltenskodex hilft dabei, ein gesundes, konstruktives Verhalten in der Gemeinde zu etablieren, das den Stress für Sie als Verantwortliche für das Projekt verringert.

Weitere Details: Verhaltenskodex - Leitfaden .

Der Verhaltenskodex beschreibt nicht nur, wie sich die Teilnehmer verhalten sollen, sondern erklärt auch, für wen und wann er gilt und was passiert, wenn er verletzt wird.

In Analogie zur Lizenz müssen Sie den Code nicht selbst schreiben, sondern können eine der vorhandenen Optionen kopieren. Mitgliedervereinbarung wird in verwendetÜber 40.000 Open Source-Projekte, darunter Kubernetes, Rails und Swift. Unabhängig davon, welchen Code Sie verwenden, sollten Sie darauf vorbereitet sein, ihn bei Bedarf anzuwenden.

Fügen Sie die Datei CODE_OF_CONDUCT.md in das Stammverzeichnis Ihres Projekts ein, damit Sie sie beispielsweise über README leichter finden und verknüpfen können.

Benennen und Branding Ihres Projekts


Branding ist nicht nur ein eingängiges Logo und ein einprägsamer Name, sondern auch, wie Sie über Ihr Projekt sprechen und wen Ihre Botschaft erreicht.

Den richtigen Namen wählen


Wählen Sie einen Namen, der leicht zu merken ist und im Idealfall eine Vorstellung von der Essenz des Projekts vermittelt. Zum Beispiel:


Wenn Ihr Projekt eine Ergänzung zu einem vorhandenen Projekt ist, verwenden Sie dessen Namen als Präfix. Dies hilft zu verstehen, was Ihr Projekt tut. Zum Beispiel bringt Node-Fetch `window.fetch` zu Node.js).

Entscheiden Sie sich für Klarheit. Wortspiele können Spaß machen, aber denken Sie an Menschen aus anderen Kulturen oder mit anderen Erfahrungen als Ihre, die den Witz möglicherweise nicht verstehen. Ihre potenziellen Benutzer können Mitarbeiter von Unternehmen sein, die mit Ihren Vorgesetzten über Ihr Projekt sprechen. Lassen Sie sie nicht gleichzeitig rot werden.

Namenskonflikt


Suchen Sie nach Open Source-Projekten mit demselben Namen , insbesondere wenn Sie dieselbe Sprache oder dasselbe Ökosystem verwenden. Wenn Ihr Name mit einem beliebten bestehenden Projekt übereinstimmt, können Sie Ihr Publikum verwirren.

Wenn Sie vorhaben, eine Website, Twitter oder eine Veröffentlichungsplattform zu starten, stellen Sie sicher, dass der von Ihnen benötigte Name dort frei ist. Und es ist besser, diese Namen jetzt zur Beruhigung zu reservieren , auch wenn Sie noch nicht vorhaben, sie zu verwenden.

Stellen Sie sicher, dass Sie nicht gegen die Marke eines Unternehmens verstoßen. In Zukunft kann sie Sie bitten, das Projekt abzuschließen oder sogar zu verklagen. Dies ist ein ungerechtfertigtes Risiko.

Sie können den Markenkonflikt in der globalen WIPO-Markendatenbank überprüfen. Wenn Sie das Projekt im Auftrag des Unternehmens durchführen, kann Ihnen die Rechtsabteilung dabei helfen .

Führen Sie abschließend eine schnelle Google-Suche nach dem Namen Ihres Projekts durch. Werden die Leute in der Lage sein, Ihr Projekt darauf leicht zu finden? Oder erscheint auf dieser Anfrage etwas Unerwünschtes?

Die Art und Weise, wie Sie schreiben (und codieren), wirkt sich auch auf Ihre Marke aus!


Während der gesamten Laufzeit des Projekts werden Sie viel schreiben: README, Leitfäden, Community-Dokumente, Antworten auf Fragen, möglicherweise sogar Newsletter und Mailinglisten.

Unabhängig davon, ob es sich um eine offizielle Dokumentation oder eine reguläre Nachricht handelt, ist Ihr Schreibstil Teil der Marke des Projekts. Denken Sie an das Licht, in dem Sie vor das Publikum schauen und ob Sie den richtigen Ton gewählt haben.
Benutzerbild , , . , , , , .
@janl, CouchDB, « Open Source»

Eine freundliche und höfliche Sprache schafft eine angenehme Atmosphäre für neue Teilnehmer. Behalten Sie auch die Einfachheit der Präsentation im Auge, da Englisch für viele Leser möglicherweise nicht muttersprachlich ist.

Nicht nur die Wörter, die Sie schreiben, sondern auch der Stil des Codes können Teil der Marke Ihres Projekts werden. Angular und jQuery sind zwei Beispielprojekte mit strengen Stilen und Empfehlungen.

Es ist nicht erforderlich, einen Styleguide zu schreiben, wenn Sie gerade erst anfangen, und auf jeden Fall möchten Sie wahrscheinlich verschiedene Styles in Ihr Projekt aufnehmen. Aber Sie müssen im Voraus verstehen, dass Ihr Schreib- und Codestil einige Leute anzieht und andere wegdrückt. Die frühen Phasen des Projekts bieten die Möglichkeit, einen Präzedenzfall zu schaffen, aus dem das Projekt in der gewünschten Form wächst.

Checkliste vor dem Start


Sind Sie bereit, Ihr Projekt zu öffnen? Hier ist eine Checkliste, die Ihnen helfen soll. Wenn Sie alle Elemente überprüft haben, klicken Sie auf "Veröffentlichen" und loben Sie sich.

Dokumentation


  • Das Projekt enthält eine Open-Source-LIZENZ-Datei
  • Das Projekt verfügt über eine grundlegende Dokumentation (README, CONTRIBUTING, CODE_OF_CONDUCT).
  • Der Name ist leicht zu merken, vermittelt einen Eindruck von der Essenz des Projekts, steht nicht in Konflikt mit bestehenden Projekten und greift nicht in Marken ein.
  • Die Liste der Probleme ist aktuell, gut organisiert und beschriftet.

Der Code


  • Das Projekt verwendet vereinbarte Codekonventionen und Anzeigenamen von Funktionen / Methoden / Variablen
  • Der Code wird klar kommentiert, Absichten und Sonderfälle werden dokumentiert.
  • Nirgendwo gibt es vertrauliche Daten wie Passwörter oder andere nicht öffentliche Informationen - in der Geschichte von Revisionen, Problemen (Issues) und Revisionsanfragen (Pull-Requests).

Menschen


Wenn Sie eine Privatperson sind:

  • Sie haben mit der Rechtsabteilung gesprochen und / oder die Regeln für geistiges Eigentum und Open Source-Richtlinien Ihres Unternehmens verstanden (wenn Sie irgendwo beschäftigt sind).

Wenn Sie eine juristische Person sind:

  • Sie haben mit der Rechtsabteilung gesprochen
  • Haben Sie einen Marketingplan für den Start und die Förderung eines Projekts?
  • Jemand wurde für die Interaktion mit der Community verantwortlich gemacht: Beantworten von Fragen, Überprüfen von Pull-Anfragen und Anhängen an das Projekt
  • Mindestens zwei Personen haben administrativen Zugriff auf das Projekt.

Du hast es geschafft!


Herzlichen Glückwunsch zum Öffnen des Quellcodes für Ihr erstes Projekt! Unabhängig vom Ergebnis ist es ein Geschenk für die Gemeinschaft, in voller Sicht auf die Menschen zu arbeiten. Jede Festschreibungs-, Kommentar- und Überarbeitungsanforderung ist eine Gelegenheit, für Sie und andere zu lernen und zu wachsen.

More articles:


All Articles