Was ich aus einem alten GitHub-Projekt gelernt habe, das in einer Woche 3.000 Sterne gewonnen hat

Eine einsame Open Source

Wir entwickeln seit drei Jahren ein Markdown WYSIWYG Editor-Projekt mit dem ersten Commit im März 2015. Ich habe am 30. Dezember 2017 an der Arbeit gearbeitet, um Version 1.0 zu veröffentlichen und es auf npm zu veröffentlichen.

Zu dieser Zeit war das Repository Ende des Jahres so leise wie die Luft im Büro. Ein Problem, das alle paar Monate einmal veröffentlicht wurde und anscheinend versucht hat zu sagen: “Dieses Projekt ist Open Source.” Es erhielt über drei Jahre genau 160 GitHub-Sterne, und eine Pull-Anfrage war schwer zu erwarten.

Keine Überraschung. Selbst von Google und Facebook gibt es Open Source-Projekte, die keine Mitwirkenden haben. Ich denke, einige von Ihnen haben möglicherweise Enttäuschungen erlebt, als Ihre wertvolle Open Source nur in die Leere ging. Darüber hinaus sind wir es gewohnt, GitHub als unser kostenloses Git-Repository zu verwenden. Sind wir nicht?

Ab Release 1.0 wollte ich, dass mehr Leute über dieses Projekt informiert werden. Ich glaubte, dass dieses Projekt mehr wert war, als es zu diesem Zeitpunkt aussah. Ich habe ein paar Dinge getan, um das zu erreichen, und als Ergebnis bekam es 2.000 Sterne in 4 Tagen und 3.000 Sterne in einer Woche! Jetzt hat es über 5.500 Sterne und volle Ausgaben und Pull-Anfragen. Es passierte in nur einem Monat.

Ich habe diesen Artikel geschrieben, um meine Erfahrungen im letzten Monat zu teilen. Ich werde Ihnen auch die Nummern zeigen, die ich aufgezeichnet habe, wenn möglich. Ich hoffe, es kann Ihnen helfen, Ihr Open Source-Projekt voll von Mitwirkenden zu machen.

Eine gute README-Datei verdient Sterne

Trotz der fast drei Jahre, in denen wir unseren Editor entwickelt hatten, schien niemand daran interessiert zu sein. Es war unvermeidlich, da die Dokumente schlecht waren.

Auch für eine Waschmaschine sollten Sie das Handbuch einmal lesen. Sie sollten noch mehr Dokumente für Ihr Projekt bereitstellen.

Die README-Datei beschreibt das Wesentliche des Projekts. Die DEMO zeigt an, dass sie einsatzbereit ist. Beispiele sollten der erste Schritt bei verschiedenen Anforderungen sein. Tutorials sollen jedem den Einstieg erleichtern.

Wenn Sie eines dieser Dokumente verpassen, geben Benutzer Ihr Projekt auf. Durch das Herausgeben von Quellcode wird Ihr Projekt nicht zu einem Open Source-Projekt.

Unter den Dokumenten spielt die README die wichtigste Rolle. Es reicht nicht aus, nur mehrere Dokumente aufzulisten. Sie, ich und die meisten Entwickler sind faul. Die meisten Besucher scrollen einfach etwa zweimal in der README-Datei nach unten und gehen, wenn sie nicht interessiert sind. Die README-Datei sollte daher den Grund angeben, warum Entwickler Ihr Projekt wünschen.

Mal sehen, welchen Unterschied das Aktualisieren der README-Datei gebracht hat. GitHub Stars sind eigentlich nichts anderes als Lesezeichen für Besucher. Die Anzahl der GitHub-Sterne gibt jedoch Auskunft darüber, wie viele Besucher an Ihrem Projekt interessiert sind.

Die folgenden Tabellen geben die Anzahl der Sterne und eindeutigen Besucher an, die ich vor und nach der Veröffentlichung des TOAST UI Editor 1.0 aufgezeichnet habe.

Es wurden keine Funktionen hinzugefügt oder das Design aktualisiert. Es gab nur Aktualisierungen der Dokumente – hauptsächlich in der README-Datei – und einige Umgestaltungen. Die folgenden Zahlen sind vollständig auf Änderungen in der README-Datei zurückzuführen.


Es wäre besser gewesen, wenn wir von Beginn des Projekts an eine Aufzeichnung hätten. Aber ich habe nur die Zahlen aufgezeichnet, um Trends zu überprüfen. Ich kann dies derzeit nicht ändern. Schauen wir uns also nur die Zahlen an und ich überlasse es Ihrem Bauchgefühl.

Vor dem Aktualisieren der README-Datei gaben etwa 4% aller Besucher einen Stern an. Überraschenderweise gaben nach der Aktualisierung der README-Datei etwa 20% aller Besucher einen Stern. Durch die Aktualisierung der README-Datei erhielt dieses Projekt fast fünfmal mehr Sterne von Besuchern!

Jeder sagt, dass die README-Datei wichtig ist. Aber wer wusste, dass es einen so großen Unterschied machen würde? Ich war auch überrascht, das zu sehen. Wenn Sie Mitwirkende an einem Projekt haben möchten, sollten Sie vor allem eine attraktive README-Datei schreiben.

Sie können leicht Artikel darüber finden, wie Sie eine schöne README-Datei bei Google schreiben. Es ist auch eine gute Idee, die READMEs in anderen Projekten zu studieren, die auf Awesome Readme aufgeführt sind.

Verbreiten Sie das Wort in der Community

Unser Projekt hatte ungefähr zehn Besucher pro Tag. Wenn Sie hart an Ihren Dokumenten gearbeitet haben, ist es Zeit, die Leute über Ihr Projekt zu informieren.

Natürlich ist es am besten, wenn jemand anderes anstelle von Ihnen das Wort über Ihr Projekt verbreitet. Aber du musst es selbst anfangen. Wenn Ihr Projekt nicht von irgendwoher verlinkt ist, wird es in der Google-Suche nicht angezeigt. Niemand würde wissen, dass Ihr Projekt existiert.

Sprechen Sie bei jeder Gelegenheit über Ihr Projekt

Beantworten Sie die Fragen zu StackOverflow und Quora. Sprechen Sie mit Personen in Facebook-Gruppen. Senden Sie einen Link zu HackerNews und Reddit. Bitten Sie den Newsletter, Ihr Projekt zu veröffentlichen.

Sie können auch Communitys bitten, Ihnen bei Ihrem Projekt zu helfen und ihnen von Ihrem Projekt zu erzählen.

Aber spammen Sie sie nicht blind. Gemeinschaften und Medien haben unterschiedliche Persönlichkeiten. Wenn Sie Ihr Projekt spammen, ohne die einzelnen Communitys zu verstehen, wird Ihr Beitrag möglicherweise gelöscht oder einfach ignoriert. Im schlimmsten Fall werden Sie möglicherweise aus diesen Communities ausgeschlossen, oder Ihr Projekt hat einen schlechten Ruf.

Seien Sie in jeder Community aktiv, um sie zu verstehen. Communitys zu kennen ist nicht nur gut für die PR. Was Sie von ihnen lernen, hilft auch Ihren Projekten.

Eines Tages sagte mir ein Verkäufer:

„Die Einbindung Ihrer Kunden in Ihre Arbeit ist der beste Weg, um treue Kunden zu gewinnen.“

Da stimme ich hundertprozentig zu. Und ich denke, wir sollten dasselbe für unsere Arbeit tun.

Als ich die README-Datei aktualisiert habe, habe ich sie gebeten, das Dokument zu überprüfen. Und zum Glück haben zwei Personen eine Pull-Anfrage gesendet, nachdem sie die neue README-Datei überprüft hatten. Ich bin sicher, die beiden interessieren sich mehr für unser Projekt als alle anderen Besucher. Ich wette, sie haben auch einen Stern in unserem Projekt getroffen.

Lernen Sie GitHub Explore

GitHub ist der beste Ort, um Ihre Mitwirkenden zu gewinnen. Wenn sich Ihr Projekt auf GitHub befindet, schauen Sie nicht zu weit weg und erfahren Sie zuerst mehr darüber. Oben auf GitHub finden Sie immer ein Menü, das Ihnen mit einem niedlichen Octocat folgt. Das Erkunden ist das, worauf wir achten sollten. Die Seite zeigt Entwicklern nützliche und interessante Open-Source-Projekte.

Explore bietet Ihnen die Möglichkeit, Ihr Projekt 24 Millionen GitHub-Benutzern vorzustellen. Deshalb sollten Sie Ihr Open Source-Projekt auf GitHub pflegen.

Andere Dienste sind ebenfalls großartig, verstehen Sie mich also nicht falsch. Ich benutze BitBucket schon sehr lange, um persönliche Projekte privat zu verwalten. GitLab hat auch wirklich nette Funktionen, die für mich in den letzten Jahren manchmal besser funktionieren als die von GitHub. Open Source-Projekte müssen jedoch auf GitHub gepflegt werden, um Besucher von Explore zu erhalten.

Sehen Sie sich an, welche Art von Projekt es gibt, entdecken Sie, was die guten Teile dieser Projekte sind und wie der aktuelle Trend verläuft. Wenn Sie die Explore-Seite noch nicht gesehen haben, ist es Zeit, sie zu überprüfen. Hier erfahren Sie, was Sie tun müssen, um Ihr Projekt zu verbessern.

Wenn Sie diese Seite öffnen, sehen Sie die Registerkarten Sammlungen, Themen und Trends – jede dieser Listen enthält nette Open Source-Projekte. Unter anderem werden wir uns mit Trends und Themen befassen. Wir können bei den Sammlungen nicht helfen, da sie von GitHub kuratiert werden.

Besucheranreize von GitHub Trending

Der Abschnitt Trending auf der Explore-Hauptseite zeigt Projekte, die in dieser Woche in allen Sprachen die meisten Sterne erhalten haben. Es wäre sehr schwer, dorthin zu gelangen.

Aber Sie müssen nicht aufgeben. Grenzen Sie den Sprach- und Datumsbereich ein und sehen Sie sich dann die Projekte in den unteren Rängen an. Es wird eine realistische Zahl geben, die Ihr Projekt auch erreichen kann.

Konzentrieren Sie sich innerhalb bestimmter Tage auf Besucher, um auf die Liste zu gelangen, indem Sie jede Community einbeziehen, in der Sie sich befinden. Wenn Sie genügend Sterne sammeln können, kann Ihr Projekt auch auf der Trendliste stehen. Die Anzahl der Sterne hängt von Ihrer Projektsprache, dem Wochentag usw. ab.

Wenn Sie ein neues Projekt veröffentlicht oder dem Projekt Funktionen hinzugefügt haben, ist dies der perfekte Zeitpunkt, um es dort zu veröffentlichen. Seien Sie nicht enttäuscht, auch wenn Ihr Projekt niedrig aufgeführt ist. Ihr Projekt wird noch zusätzliche Besucher bekommen. Stellen Sie sich den Abschnitt “Trends” als Anreiz für Besucher vor, basierend auf Ihrem Rang.

Die obige Tabelle zeigt eine Aufschlüsselung der Besucher von GitHub Insight, nachdem ich sie am 10. Januar in verschiedenen Communitys verbreitet habe. Wenn Sie auf Websites in GitHub Insight verweisen, werden Werte aus einem Zeitraum von zwei Wochen angegeben. Sie müssen daher einige Berechnungen durchführen, um die Zahlen zu erhalten Sie wollen.

Am 10. Januar, dem ersten Tag, kamen fast alle Besucher aus meinen eigenen Gemeinden. Glücklicherweise zeigt ein kleiner GitHub.com-Teil in der Tabelle, dass unser Editor auf der Trendliste stand. Am nächsten Tag, am 11. Januar, brachte GitHub bereits die Hälfte des Verkehrs ein. Es ist ein guter Anreiz, auf der Trendliste zu stehen.

Am nächsten Tag, am 12. Januar, wurde der Editor in allen Sprachen als der Trend 1 von heute aufgezeichnet. Die meisten Besucher kamen von GitHub. Von diesem Tag an gingen die Besucherzahlen der von mir selbst verfassten Beiträge erheblich zurück. Andererseits tauchten mit zunehmender Sichtbarkeit Besucher von unerwarteten Empfehlern auf.

Am folgenden Tag, dem 13. Januar, kamen die meisten Besucher von GitHub. Der Herausgeber verzeichnete an diesem Tag 2.000 Sterne, vier Tage nachdem er in den Communities veröffentlicht wurde. Obwohl das Wachstum seitdem einen Monat später zurückgegangen ist, zieht der Trend für diesen Monat immer noch neue Besucher an.

Ständige Besucher von GitHub-Themen

Themen zeigen Projekte in der Reihenfolge der Anzahl der Sterne in einem Thema.

Dies bedeutet, dass Ihr Projekt, sobald es genügend Sterne hat, um in einem Thema aufgeführt zu werden, weiterhin Besucher durch das Thema führen kann, selbst wenn Ihr Projekt nicht im Trend aufgeführt ist.

Es gibt nicht so viele Besucher aus der Themenliste wie aus dem Trend. Aber es lohnt sich trotzdem.

Ich habe viele Projekte gesehen, die keine Themen haben. Sehen Sie sich das Bild oben an, um zu sehen, wo Sie Themen in Ihrem Projekt einrichten können. Sie können beliebige Themen einrichten.

GitHub verwaltet jedoch eine Liste mit dem Namen “Ausgewählte Themen”. Daher ist es besser, die relevanten Themen aus den empfohlenen Themen auszuwählen, um mehr Besucher zu erhalten.

Darüber hinaus variiert die Anzahl der Sterne, die oben aufgeführt werden müssen, je nach Thema erheblich.

Nehmen Sie das JavaScript-Thema als Beispiel. Es gibt Projekte in Dinosauriergröße wie FreeCodeCamp (Hallo Leute 🙋), BootStrap, React, Vue und so weiter. Dies macht es ungefähr 100 Mal schwieriger, Ihr Projekt in diese Liste aufzunehmen.

Unser Editor belegt im Markdown-Thema mit 5,4.000 Sternen den 10. Platz. Schauen Sie sich die Themen an und wählen Sie Themen aus, die nicht zu wettbewerbsfähig sind.

Die beste einzelne Zeile für Ihre Projektbeschreibung

Lassen Sie uns die Beschreibung im obigen Bild noch einmal finden. Wie lautet die Projektbeschreibung für Ihr Projekt? Ich hatte die Beschreibung unseres Herausgebers als lange Version des Titels geschrieben (dies ist eine schlechte Idee). Hast du dir deine Linie ausgedacht? Schauen wir uns dann das nächste Bild an.

So sieht unser Projekt in Bezug auf Trends und Themen aus. Versuchen Sie es aus der Sicht der Besucher zu betrachten. Es gibt eine Organisation, einen Namen, Bilder von Mitwirkenden und so weiter. Die einzige nützliche Information, um zu bestimmen, ob geklickt werden soll oder nicht, ist die Beschreibung.

Die Beschreibung sollte die beste einzelne Zeile sein, um Ihr Projekt zu beschreiben.

Letztes Wort

Dokumente schreiben. Sei aktiv in Gemeinschaften. Verwenden Sie die Tools von GitHub.

Die Tipps, die ich in diesem Artikel teile, helfen Ihnen dabei, Ihr Projekt als Open Source zu verbessern (zusätzlich zu mehr Sternen).

Aber diese Tipps allein können Ihr Projekt ohne den Wert Ihres Projekts selbst nicht populär machen. Ich hoffe, dieser Artikel hilft Ihnen dabei, die Mitwirkenden zu finden, die Ihr Projekt verdient.

Ich hatte die Gelegenheit, diesen Artikel zu schreiben, weil die ehemaligen Betreuer (Shiren, JungHwan), die für dieses Projekt großartige Arbeit geleistet haben. Ich glaube, dieses Projekt hatte bereits den Wert, den es heute hat. Und die Tipps in diesem Artikel haben uns geholfen, den Rest zu erreichen.

Letzten Monat hatte ich als Entwickler eine ganz besondere Erfahrung. Ich möchte der TOAST UI Familie und dem Dooray danken! Team für all Ihre Unterstützung!

Wenn Sie sich für den TOAST UI Editor interessieren, empfehle ich Ihnen, Dooray auszuprobieren! auch. Es wird mit dem Editor geliefert und ist für weniger als 100 Mitarbeiter kostenlos. Lassen Sie den TOAST UI Editor bei sich sein 🙏

Ursprünglich geschrieben bei Toast Meetup, geschrieben von KyuWoo Choi 🌵