Dit materiaal was oorspronkelijk gepost op Habr.com in het Russisch. De auteur stond toe dat het werd vertaald en gepubliceerd op Codingsight.
Misschien heeft iedereen ergens een bestand om bepaalde spannende en nuttige dingen te bewaren, zoals links naar artikelen, boeken, repositories, handleidingen, enz. Je zou bladwijzers in een browser of tabbladen kunnen gebruiken, die nog steeds open staan en op je wachten. Na verloop van tijd groeit het allemaal buitensporig, links worden verbroken en materialen raken verouderd.
Maar wat als we deze inzichtelijke juweeltjes met de gemeenschap zouden kunnen delen? Een bestand uploaden naar GitHub? Dan zouden uw bevindingen nuttig zijn voor iemand anders. Bovendien zou het gemakkelijker zijn om het bestand samen up-to-date te houden, door de lijst up-to-date te houden via de goede oude pull-verzoeken.
Dit is waar we het Awesome Lists-project voor hebben.
Awesome Lists behoort tot de top-10 GitHub-repositories, met al 138k "sterren", en een link naar je werken kan de root README goedmaken, waardoor een enorm publiek wordt aangetrokken. Je zult echter eerst wat moeite moeten doen. Hier wil ik mijn ervaring delen.
Ik ben Maksim Gramin, een Java-ontwikkelaar en database-onderzoeker bij CROC, een internationaal IT-bedrijf met het hoofdkantoor in Moskou. Dit artikel zal je vertellen over Awesome Lists en hoe je je officiële geweldige repo kunt maken.
Waar gaan geweldige lijsten over?
Telkens als ik met een nieuwe technologie of een programmeertaal te maken heb, ga ik daar eerst heen, op zoek naar de benodigde sectie en passende lijsten. Gezien het grote en steeds toenemende aantal "sterren", ben ik niet de enige persoon met een dergelijke benadering.
In feite is "Awesome Lists" een standaard leesmij.md die in een aparte repository leeft. Het neemt echter de 8-positie in van alle GitHub-repositories en bevat andere lijsten die aan bepaalde onderwerpen zijn gewijd. De sectie Programmeertalen heeft bijvoorbeeld Awesome Python- en Awesome Go-lijsten, terwijl de sectie Front-End Development tal van webontwikkelingsmateriaal opslaat. Last but not least is er het gedeelte Database (we zullen er later over praten).
Natuurlijk is de inhoud niet beperkt tot alleen technische onderwerpen en omvat ook andere secties, zoals Entertainment en Gaming. Je kunt daar ook veel spannende dingen vinden (ik was erg blij met de geweldige fantasielijst).
Het belangrijkste onderscheid van het project is dat al deze lijsten niet alleen door de auteur, maar ook door de gemeenschap worden beheerd. Bovendien zijn ze allemaal gemaakt volgens een strikt Awesome Manifesto. Elke lijst vertegenwoordigt een aparte gemeenschap van specialisten, die zijn eigen leven leidt en openstaat voor je pull-verzoeken, wat het nog beter zal maken. Bovendien kan iedereen zijn eigen lijst maken voor het geval een bepaald onderwerp niet onderzocht kan worden.
Voor het originele idee en de coördinatie van al deze dingen moeten we de legendarische Sindre Sorhus, de eerste man op GitHub en de auteur van meer dan 1000 npm-modules, dankbaar zijn. Hij is degene die je pull-verzoeken accepteert.
Een geweldige lijst maken
Als je de juiste lijst voor het benodigde onderwerp niet hebt gevonden, is dit het eerste teken dat je het zelf moet doen! Ik zal je vertellen hoe je het moet doen aan de hand van het voorbeeld van mijn eigen creatie - Awesome Database Tools.
Project voor project kreeg ik te maken met allerlei databases. Dus begon ik een aantal bestanden te beheren waarin ik verschillende handige tools voor mijn werk verzamelde. Er waren verschillende DB-migrators, IDE, beheerderspanelen, monitoringtools, enz., inclusief degene die ik al gebruikte of alleen van plan was.
Ik deelde dit dossier met mijn collega's bij CROC en daarbuiten, aangemoedigd door te zien hoe velen van hen er baat bij hadden. Toen wilde ik meer. Toen ik merkte dat er in de sectie Databases geen lijst was gewijd aan de tools, besloot ik de mijne toe te voegen.
Wat heb je daarvoor nodig?
- Registreer een standaard GitHub-repo en noem deze awesome-smth - in mijn geval was het awesome-database-tools.
- Pas de lijst aan naar de geweldige formaat met behulp van generator-awesome-list die alle benodigde bestanden in het juiste formaat zal genereren.
- Configureer continue integratie (CI) – awesome-lint en Travis CI helpen ons de geldigheid van de lijst te controleren.
- Wacht 30 dagen.
- Bekijk ten minste 2 andere pull-verzoeken.
- Maak een pull-verzoek aan de hoofdopslagplaats en voeg een link toe aan onze eigen opslagplaats. Belangrijk :Lees aandachtig alle talrijke vereisten voor de nieuwe lijst en pull-verzoeken, en volg ze nauwkeurig.
Mijn eerste poging is niet gelukt.
Na een tijdje verzamelde ik echter meer materiaal, deed ik mijn huiswerk, herstelde ik de fouten en probeerde ik het een tweede keer.
Maar ik vergat één cruciaal ding, en ze herinnerden me er beleefd aan:
Ik was niet attent genoeg en voegde geen eenhoorn toe als bevestiging dat aan alle voorwaarden was voldaan.
Er ging wat meer tijd voorbij, ik kreeg wat meer opmerkingen en voegde amendementen toe, en ten slotte zag ik een langverwachte twit dat mijn PR was geaccepteerd.
Dit is hoe ik mijn eerste lijst heb gemaakt en de pull-verzoeken van de community voor het toevoegen van nieuwe tools begon te ontvangen. Velen van hen zijn al opgenomen in Awesome Database Tools.
Als je goede ideeën hebt voor databases, deel ze dan gerust. Ook ontvang ik graag feedback van u, zoals pull-verzoeken en sterren. Als je vragen hebt over het maken van je eigen lijsten, laat het me dan weten.
U kunt de auteur bereiken via [email protected].