10 Punkte von GN⁺ 2024-02-15 | 6 Kommentare | Auf WhatsApp teilen

Non-Code-Beiträge sind der Schlüssel zum Erfolg von Open Source

  • Die Mathematiklehrerin Sarah Rainsberger hatte nicht vor, freiwillig Open-Source-Mitwirkende zu werden, begann jedoch beim Neuaufbau der Website ihres Chors, JavaScript und Webentwicklung zu lernen.
  • Bei der Nutzung des Frontend-Frameworks Astro steuerte sie dem Projekt eine kleine Codeänderung in Form einer Konfigurationsdatei bei, beteiligte sich an der Community und übernahm die Rolle, neue Astro-Nutzer zu unterstützen.
  • Rainsberger ist heute Teil der Kern-Maintainer-Gruppe von Astro, arbeitet jedoch kaum an der Codebasis und konzentriert sich vor allem auf die Dokumentation sowie darauf, anderen beim Lernen von Astro zu helfen.

Wichtige Non-Code-Arbeiten in Open-Source-Projekten

  • Open-Source-Projekte benötigen neben dem Schreiben von Code auch Dokumentation, Lokalisierung, Marketing, Grafikdesign, Testing, Community-Management und Release-Management.
  • Die Bedeutung von Non-Code-Beiträgen ist sehr groß; je komplexer ein Projekt ist, desto mehr Dokumentation, Tutorials und Support werden benötigt, damit der Code nützlich wird.
  • Grafikdesign, Branding und Outreach dienen als Signale für die Gesundheit und Seriosität eines Projekts und können dazu beitragen, dass andere Projekte oder Unternehmen es als Abhängigkeit nutzen.

Warum man mit Non-Code-Beiträgen beginnen sollte

  • Non-Code-Beiträge bieten Menschen, die sich für Rollen ohne Programmierung interessieren, etwa in technischer Kommunikation, Grafikdesign oder User Experience Design, die Möglichkeit, ein Portfolio aufzubauen.
  • Auch Programmierer profitieren davon, ihre Schreib- und Kommunikationsfähigkeiten zu schärfen, was beim Wechsel in Rollen wie Developer Relations oder Produktmanagement helfen kann.
  • Open-Source-Projekte bieten Menschen aller Kenntnisstufen die Möglichkeit zur Mitarbeit, und ohne ein tiefes Verständnis des Projekts ist es schwierig, sinnvolle Code-Beiträge zu leisten.

Non-Code-Mitwirkende finden und Wertschätzung zeigen

  • Für Maintainer ist es am besten, Mitwirkende zu finden, indem sie gezielt nach bestimmten Aufgaben fragen; außerdem hilft es, eine Community aufzubauen und Issues mit Tags wie "Hilfe gesucht" und "Good First Issue" anzulegen.
  • Mentoring ist eine der besten Methoden, um Mitwirkende zum Erfolg zu führen, und Non-Code-Mitwirkende wertzuschätzen und sichtbar anzuerkennen hilft dabei, bestehende Mitwirkende zu motivieren und neue anzuziehen.

Meinung von GN⁺

  • Entscheidend ist, dass der Erfolg von Open-Source-Projekten vielfältige Beiträge erfordert, die weit über das reine Schreiben von Code hinausgehen. Das ist ein wesentlicher Faktor für die Nachhaltigkeit und das Wachstum eines Projekts.
  • Non-Code-Beiträge eröffnen auch nichttechnischen Menschen die Möglichkeit, sich an Open Source zu beteiligen, und helfen zugleich beim Aufbau technischer Fähigkeiten.
  • Dieser Artikel kann Menschen inspirieren, die sich für die Open-Source-Community interessieren, und ihnen helfen, Wege zu finden, mit ihren eigenen Fähigkeiten zur Community beizutragen.

6 Kommentare

 
secret3056 2024-02-15

Das ist zwar eine etwas andere Geschichte, aber vor Kurzem hat jemand ein Tutorial dazu veröffentlicht, einen PR für die README-Datei von Express.js einzureichen, woraufhin Hunderte bedeutungsloser PRs eingegangen sind.

Pull requests · expressjs/express

 
mdisprgm 2024-02-16

Eine Belastung.. schnief

 
edunga1 2024-02-15

Das sind ja über 100 PRs, krass.

 
sagee 2024-02-15

Ich war kurz verwirrt, wie man mit „Barcode“ beitragen soll, aber … haha
So gesehen kann eine ausführliche Dokumentation durchaus ein zweischneidiges Schwert sein.
Es könnte auch Fälle geben, in denen Dokumentation und Screenshots so detailliert werden, dass Entwickler sich nicht zutrauen, die Doku zu aktualisieren, und deshalb darauf verzichten, Verbesserungen weiterzuentwickeln..

 
cosine20 2024-02-16

Es ist („Nicht-“-)Code)

 
GN⁺ 2024-02-15
Hacker-News-Kommentar
  • Als Autor/Betreuer kleiner Bibliotheken kann ich bestätigen, dass die Handbücher ohne externe Beiträge nicht annähernd so gut wären wie heute. Handbücher tragen wesentlich zur Nutzbarkeit eines Projekts bei.

    • Als neuer Nutzer von libcurl konnte ich dank des Tutorials und der API-Dokumentation FTP-Uploads schnell implementieren und an einen bestimmten Anwendungsfall anpassen.
    • Durch die Dokumentation konnte ich erkennen, dass älteren Versionen Thread-Sicherheit fehlte, und mein Team vor einem Update warnen.
    • Dokumentation ist genauso wichtig wie Code und die Test-Suite.
  • Wünsche an Open-Source-Projekte:

    • viele Screenshots
    • eine sehr lange und detaillierte README.md
    • Tutorials, Referenzdokumentation, Designdokumente, Architekturdiagramme
    • Dokumente zu mentalen Modellen, die erklären, wie der Autor denkt
  • Dokumentation, Assets usw. sind in Open Source wichtig, können aber auch Nicht-Entwicklern Macht geben und ein Projekt ruinieren.

    • Das kann Stabilität, Funktionalität und Adoption schaden, etwa wenn UX mit jedem Release neu erfunden wird.
    • Es zieht Menschen an, die stark an Politik interessiert sind, und führt leicht zu "bikeshedding" in Bereichen, von denen jeder glaubt, dass er sie beurteilen kann.
  • Für den Community-Aufbau ist es gut, Chat-Plattformen wie Discord, Gitter und Slack zu nutzen.

    • Das senkt die Hemmschwelle, im Repository Fragen zu stellen.
    • Auf GitHub Fragen zu stellen oder Pull Requests zur Problemlösung zu erstellen, fühlt sich oft sinnlos an.
    • Unter Erstellern von GitHub-Projekten ist die Haltung weit verbreitet: "Ich habe den Code veröffentlicht, also schulde ich darüber hinaus nichts."
  • Aus meiner Erfahrung in der WordPress-Community denke ich, dass die frühe Dokumentation und die starke Dokumentation im Codex erheblich zum Wachstum von WordPress beigetragen haben.

    • Als Joomla, Drupal und WordPress bei der installierten Basis ähnlich lagen, war der Einstieg in WordPress dank der umfangreichen Dokumentation einfacher.
  • Mein größter Wunsch an Open-Source-Projekte ist, dass Menschen sie nutzen und in irgendeiner Form festhalten, was sie damit gemacht haben.

    • Eine Nachricht im Discord-Kanal des Projekts, ein Tweet, eine kurze Nachricht, ein Screenshot, ein Gist, ein öffentliches GitHub-Repository oder ein YouTube- oder TikTok-Video sind alles sehr wertvolle Beiträge für ein Projekt.
  • Ich bin mir nicht sicher, ob Nicht-Code-Beiträge das Erfolgsgeheimnis eines Projekts sind, stimme aber zu, dass sie sehr wichtig sind.

    • Die Eclipse Foundation erinnert Nutzer zum Beispiel daran, dass auch Bug Reports wertvolle Beiträge sind.
  • Beim Start eines Open-Source-Projekts gibt es die Erwartung, dass zehnmal mehr Engineers die Software nutzen werden als Engineers tatsächlich Code dafür schreiben.

    • Nutzer sollten beitragen können, indem sie die Dokumentation verbessern.
    • Wenn man mit einem statischen Site-Generator wie Hugo Dokumentation (Benutzerhandbuch) erstellt, braucht man eine Möglichkeit, mit der Nutzer Korrekturen/Updates für die Dokumentation einreichen können, ohne ein GitHub-Issue zu erstellen.
  • Wenn nichttechnische Menschen ein Projekt verstehen und darin Wert sehen, ist das ein guter Indikator für den Erfolg des Projekts.

  • Dokumentation ist wichtig, wenn ein Produkt vom Stadium, in dem es von Fans genutzt wird, obwohl es kaum bekannt ist, in die Phase übergeht, in der es mehr Nutzer finden muss.

    • Ohne gute Dokumentation ist es schwer, diese Phase zu überwinden.
    • Das erinnert mich daran, dass ich ein Benutzerhandbuch für Neural Amp Modeller schreiben muss.