Dieses Material war ursprünglich auf Habr.com gepostet auf Russisch. Der Autor erlaubte die Übersetzung und Veröffentlichung auf Codingsight.
Vielleicht hat jeder irgendwo eine Datei, um bestimmte aufregende und nützliche Dinge zu speichern, wie Links zu Artikeln, Büchern, Repositories, Handbüchern usw. Sie können Lesezeichen in einem Browser oder Registerkarten verwenden, die noch geöffnet sind und auf Sie warten. Mit der Zeit wächst alles übermäßig, Links werden unterbrochen und Materialien werden veraltet.
Aber was wäre, wenn wir diese aufschlussreichen Juwelen mit der Community teilen könnten? Eine Datei auf GitHub hochladen? Dann wären Ihre Ergebnisse für jemand anderen nützlich. Außerdem wäre es einfacher, die Datei gemeinsam auf dem neuesten Stand zu halten und die Liste über die guten alten Pull-Requests zu aktualisieren.
Dafür haben wir das Awesome Lists-Projekt.
Awesome Lists gehört zu den Top-10 der GitHub-Repositories, mit bereits 138.000 „Sternen“, und ein Link zu Ihren Werken kann es bis zu seiner Root-README schaffen und so ein riesiges Publikum anziehen. Allerdings muss man sich vorher etwas anstrengen. Hier möchte ich meine Erfahrungen teilen.
Ich bin Maksim Gramin, ein Java-Entwickler und Datenbankforscher bei CROC, einem internationalen IT-Unternehmen mit Hauptsitz in Moskau. In diesem Artikel erfahren Sie mehr über Awesome Lists und wie Sie Ihr offizielles Awesome-Repo erstellen.
Worum geht es bei fantastischen Listen?
Wann immer ich mich mit einer neuen Technologie oder einer Programmiersprache auseinandersetzen muss, gehe ich zuerst dorthin und suche nach dem notwendigen Abschnitt und den passenden Listen. Angesichts der großen und ständig wachsenden Zahl von „Sternen“ bin ich nicht die einzige Person mit einem solchen Ansatz.
Tatsächlich ist „Awesome Lists“ eine einfache readme.md, die in einem separaten Repository lebt. Es belegt jedoch die 8. Position unter allen GitHub-Repositories und enthält andere Listen, die bestimmten Themen gewidmet sind. Beispielsweise enthält der Abschnitt Programmiersprachen Awesome Python- und Awesome Go-Listen, während der Abschnitt Front-End-Entwicklung zahlreiche Webentwicklungsmaterialien enthält. Zu guter Letzt gibt es noch den Datenbank-Bereich (darüber sprechen wir etwas später).
Natürlich beschränkt sich der Inhalt nicht nur auf technische Themen, sondern umfasst auch andere Bereiche wie Unterhaltung und Gaming. Dort findet man auch viele spannende Sachen (ich war sehr zufrieden mit der Awesome-Fantasy-Liste).
Der Hauptunterschied des Projekts besteht darin, dass all diese Listen nicht nur vom Autor, sondern von der Community verwaltet werden. Außerdem werden sie alle nach einem strengen Awesome Manifesto hergestellt. Jede Liste repräsentiert eine separate Community von Spezialisten, die ihr eigenes Leben führen und offen für Ihre Pull-Requests sind, was sie noch besser macht. Darüber hinaus kann jeder seine eigene Liste erstellen, falls ein Thema nicht erforscht ist.
Für die originelle Idee und die Koordination all dieser Dinge sollten wir dem legendären Sindre Sorhus, dem ersten Mann auf GitHub und dem Autor von über 1.000 npm-Modulen, dankbar sein. Er ist derjenige, der Ihre Pull-Requests annehmen wird.
Wie man eine tolle Liste erstellt
Wenn Sie nicht die richtige Liste für das notwendige Thema gefunden haben, ist dies das erste Anzeichen dafür, dass Sie es selbst tun sollten! Ich erkläre Ihnen, wie es geht, am Beispiel meiner eigenen Kreation – Awesome Database Tools.
Projekt für Projekt musste ich mich mit allen Arten von Datenbanken auseinandersetzen. Also fing ich an, einige Dateien zu verwalten, in denen ich verschiedene hilfreiche Tools für die Arbeit sammelte. Es gab verschiedene DB-Migratoren, IDE, Admin-Panels, Überwachungstools usw., einschließlich derer, die ich bereits verwendet habe oder nur geplant hatte.
Ich habe diese Datei mit meinen Kollegen bei CROC und darüber hinaus geteilt, ermutigt, weil ich gesehen habe, wie viele von ihnen davon profitiert haben. Dann wollte ich mehr. Als ich bemerkte, dass im Abschnitt „Datenbanken“ eine den Tools gewidmete Liste fehlte, beschloss ich, meine hinzuzufügen.
Was braucht man dafür?
- Registrieren Sie ein Standard-GitHub-Repo und benennen Sie es wie awesome-smth – in meinem Fall war es awesome-database-tools.
- Passen Sie die Liste super an Format mit generator-awesome-list, das alle notwendigen Dateien im richtigen Format generiert.
- Kontinuierliche Integration (CI) konfigurieren – awesome-lint und Travis CI helfen uns, die Gültigkeit der Liste zu kontrollieren.
- Warten Sie 30 Tage lang.
- Prüfen Sie mindestens zwei weitere Pull-Requests.
- Stellen Sie eine Pull-Anfrage an das Hauptrepo und fügen Sie einen Link zu unserem eigenen Repo hinzu. Wichtig :Lesen Sie alle zahlreichen Anforderungen an die neue Liste und die Pull-Requests sorgfältig durch und befolgen Sie sie genau.
Mein erster Versuch war nicht erfolgreich.
Nach einiger Zeit sammelte ich jedoch mehr Material, machte meine Hausaufgaben, korrigierte die Fehler und versuchte es ein zweites Mal.
Aber ich habe eine entscheidende Sache vergessen, und sie haben mich höflich daran erinnert:
Ich war nicht aufmerksam genug und habe kein Einhorn als Bestätigung hinzugefügt, dass alle Bedingungen erfüllt sind.
Es verging einige Zeit, ich bekam weitere Anmerkungen und Ergänzungen, und schließlich sah ich einen lang erwarteten Trottel, dass meine PR akzeptiert worden war.
So habe ich meine erste Liste erstellt und angefangen, die Pull-Requests der Community zum Hinzufügen neuer Tools zu erhalten. Viele davon sind bereits in den Awesome Database Tools enthalten.
Wenn Sie gute Ideen für Datenbanken haben, können Sie diese gerne teilen. Außerdem freue ich mich über Feedback von Ihnen, wie z. B. Pull-Requests und Sterne. Wenn Sie Fragen zum Erstellen Ihrer eigenen Listen haben, lassen Sie es mich bitte wissen.
Sie erreichen den Autor unter [email protected].
