Dette materiale var oprindeligt indsendt på Habr.com på russisk. Forfatteren tillod det at blive oversat og publiceret på Codingsight.
Måske har alle et eller andet sted en fil til at opbevare visse spændende og nyttige ting, såsom links til artikler, bøger, depoter, manualer osv. Du kan bruge bogmærker i en browser eller faner, der stadig er åbne og venter på dig. Over tid vokser det hele overdrevent, links bliver ødelagt, og materialer bliver forældede.
Men hvad nu hvis vi kunne dele disse indsigtsfulde perler med samfundet? Vil du uploade en fil til GitHub? Så ville dine resultater være nyttige for en anden. Desuden ville det være nemmere at holde filen opdateret sammen ved at få listen opdateret via de gode gamle pull-anmodninger.
Det er det, vi har projektet Awesome Lists til.
Awesome Lists er blandt de 10 bedste GitHub-lagre, der allerede kan prale af 138.000 "stjerner", og et link til dine værker kan gøre det op til dets rod README og dermed tiltrække et stort publikum. Du skal dog gøre en indsats først. Her vil jeg gerne dele min erfaring.
Jeg er Maksim Gramin, en Java-udvikler og databaseforsker hos CROC, en international it-virksomhed med hovedkvarter i Moskva. Denne artikel vil fortælle dig om Awesome Lists og hvordan du laver din officielle awesome-repo.
Hvad handler Awesome Lists om?
Når jeg skal beskæftige mig med ny teknologi eller et programmeringssprog, går jeg først dertil og leder efter det nødvendige afsnit og passende lister. I betragtning af det store og stadigt stigende antal "stjerner" er jeg ikke den eneste person med en sådan tilgang.
Faktisk er "Awesome Lists" en almindelig almindelig readme.md, der bor i et separat depot. Det indtager dog den 8. plads blandt alle GitHub-lagrene og inkluderer andre lister dedikeret til bestemte emner. For eksempel har sektionen Programmeringssprog Awesome Python og Awesome Go lister, mens Front-End Development sektionen gemmer adskillige webudviklingsmaterialer. Sidst, men ikke mindst, er der Databasesektionen (vi taler om det lidt senere).
Naturligvis er indholdet ikke begrænset til kun tekniske emner og inkluderer også andre sektioner, såsom underholdning og spil. Du kan også finde mange spændende ting der (jeg var virkelig glad for den fantastiske-fantasy-liste).
Projektets vigtigste skelnen er, at alle disse lister ikke kun administreres af forfatteren, men af fællesskabet. Desuden er de alle lavet i henhold til et strengt Awesome Manifesto. Hver liste repræsenterer et separat fællesskab af specialister, der lever sit eget liv og er åben for dine pull-anmodninger, hvilket vil gøre det endnu bedre. Desuden kan enhver oprette deres egen liste, hvis et emne mangler at blive udforsket.
For original idé og koordinering af alt det her, skal vi være taknemmelige over for legendariske Sindre Sorhus, den første mand på GitHub og forfatteren af 1.000+ npm-moduler. Han er den, der vil acceptere dine pull-anmodninger.
Sådan laver du en fantastisk liste
Hvis du ikke har fundet den rigtige liste til det nødvendige emne, er det det første tegn på, at du bør gøre det selv! Jeg vil fortælle dig, hvordan du gør det ved at bruge eksemplet på min egen skabelse – Awesome Database Tools.
Projekt for projekt skulle jeg beskæftige mig med alle slags databaser. Således begyndte jeg at administrere nogle filer, hvor jeg samlede forskellige nyttige værktøjer til arbejdet. Der var forskellige DB-migratorer, IDE, admin paneler, overvågningsværktøjer osv., inklusive dem jeg allerede brugte eller kun planlagde.
Jeg delte denne fil med mine kolleger hos CROC og videre, opmuntret af at se, hvordan det gavnede mange af dem. Så ville jeg have mere. Da jeg bemærkede, at databasesektionen manglede en liste dedikeret til værktøjerne, besluttede jeg at tilføje min.
Hvad skal du bruge til det?
- Registrer en standard GitHub-repo og navngiv den som awesome-smth – i mit tilfælde var det awesome-database-tools.
- Juster listen til den fantastiske format ved hjælp af generator-awesome-list, der genererer alle de nødvendige filer i det rigtige format.
- Konfigurer kontinuerlig integration (CI) – awesome-lint og Travis CI hjælper os med at kontrollere listens gyldighed.
- Vent i 30 dage.
- Gennemgå mindst 2 andre pull-anmodninger.
- Foretag en pull-anmodning til hovedrepoen, og tilføj et link til vores egen repo. Vigtigt :Læs omhyggeligt alle de talrige krav til den nye liste og pull-anmodninger, og følg dem præcist.
Mit første forsøg lykkedes ikke.
Men efter nogen tid samlede jeg flere materialer, lavede mine lektier, rettede fejlene og forsøgte en anden gang.
Men jeg glemte en afgørende ting, og de mindede mig høfligt om det:
Jeg var ikke opmærksom nok og tilføjede ikke en enhjørning som en bekræftelse på, at alle betingelser var opfyldt.
Der gik noget mere tid, jeg fik nogle flere bemærkninger og tilføjede ændringsforslag, og endelig så jeg en længe ventet twit om, at min PR var blevet accepteret.
Sådan lavede jeg min første liste og begyndte at modtage fællesskabets pull-anmodninger om at tilføje nye værktøjer. Mange af dem er allerede inkluderet i Awesome Database Tools.
Har du gode idéer til databaser – del dem gerne. Jeg vil også være glad for at få feedback fra dig, såsom pull-anmodninger og stjerner. Hvis du har spørgsmål om at lave dine egne lister, så lad mig det vide.
Du kan kontakte forfatteren på [email protected].