Detta material var ursprungligen postat på Habr.com på ryska. Författaren tillät att den översattes och publicerades på Codingsight.
Kanske har alla någonstans en fil för att hålla vissa spännande och användbara saker, som länkar till artiklar, böcker, arkiv, manualer, etc. Du kanske använder bokmärken i en webbläsare eller flikar, fortfarande öppna och väntar på dig. Med tiden växer allt överdrivet, länkar bryts och material blir föråldrat.
Men tänk om vi kunde dela dessa insiktsfulla pärlor med samhället? Ladda upp en fil till GitHub? Då skulle dina resultat vara användbara för någon annan. Dessutom skulle det vara lättare att hålla filen uppdaterad tillsammans och få listan uppdaterad via de gamla goda pull-förfrågningarna.
Det är detta vi har projektet Awesome Lists till.
Awesome Lists är bland de 10 bästa GitHub-förråden, som redan har 138 000 "stjärnor", och en länk till dina verk kan göra det upp till sin rot README, och på så sätt locka en enorm publik. Men du måste anstränga dig först. Här vill jag dela med mig av min erfarenhet.
Jag är Maksim Gramin, en Java-utvecklare och databasforskare på CROC, ett internationellt IT-företag med huvudkontor i Moskva. Den här artikeln kommer att berätta om Awesome Lists och hur du gör din officiella awesome-repo.
Vad handlar Awesome Lists om?
Närhelst jag har att göra med någon ny teknik eller ett programmeringsspråk, går jag dit först och letar efter den nödvändiga delen och lämpliga listor. Med tanke på det stora och ständigt ökande antalet "stjärnor" är jag inte den enda personen med ett sådant tillvägagångssätt.
Faktum är att "Awesome Lists" är en vanlig vanlig readme.md som bor i ett separat arkiv. Det upptar dock 8-positionen bland alla GitHub-förråd och inkluderar andra listor dedikerade till vissa ämnen. Till exempel har avsnittet Programmeringsspråk Awesome Python och Awesome Go listor, medan Front-End Development-sektionen lagrar många webbutvecklingsmaterial. Sist men inte minst finns det avsnittet Databas (vi ska prata om det lite senare).
Naturligtvis är innehållet inte begränsat till enbart tekniska ämnen och inkluderar även andra avsnitt, såsom Underhållning och Spel. Du kan hitta många spännande saker där också (jag var riktigt nöjd med den fantastiska-fantasy-listan).
Projektets huvudsakliga skillnad är att alla dessa listor hanteras inte bara av författaren utan av gemenskapen. Dessutom är de alla gjorda enligt ett strikt Awesome Manifesto. Varje lista representerar en separat gemenskap av specialister, som lever sitt eget liv och är öppen för dina pull-förfrågningar, vilket kommer att göra det ännu bättre. Dessutom kan vem som helst skapa sin egen lista ifall något ämne inte kan utforskas.
För originalidéer och koordinering av allt det här borde vi vara tacksamma mot legendariska Sindre Sorhus, den första mannen på GitHub och författaren till 1 000+ npm-moduler. Han är den som kommer att acceptera dina pull-förfrågningar.
Hur man skapar en fantastisk-lista
Om du inte har hittat rätt lista för det nödvändiga ämnet är det första tecknet på att du bör göra det själv! Jag ska berätta för dig hur du gör det genom exemplet med mitt eget skapande – Fantastiska databasverktyg.
Projekt för projekt fick jag ta itu med alla typer av databaser. Därför började jag hantera några filer där jag samlade olika användbara verktyg för arbetet. Det fanns olika DB-migratorer, IDE, adminpaneler, övervakningsverktyg etc., inklusive de jag redan använde eller bara planerade att göra.
Jag delade den här filen med mina kollegor på CROC och därefter, uppmuntrad av att se hur den gynnade många av dem. Då ville jag ha mer. När jag märkte att avsnittet Databaser saknade en lista dedikerad till verktygen, bestämde jag mig för att lägga till min.
Vad behöver du för det?
- Registrera en standard GitHub-repo och namnge den som awesome-smth – i mitt fall var det awesome-database-tools.
- Justera listan till den häftiga formatera med generator-awesome-list som genererar alla nödvändiga filer i rätt format.
- Konfigurera kontinuerlig integration (CI) – awesome-lint och Travis CI hjälper oss att kontrollera listans giltighet.
- Vänta i 30 dagar.
- Granska minst två andra pull-begäranden.
- Gör en pull-förfrågan till huvudrepån och lägg till en länk till vår egen repo. Viktigt :Läs noga igenom alla de många kraven till den nya listan och pull-förfrågningar och följ dem noggrant.
Mitt första försök lyckades inte.
Men efter en tid samlade jag mer material, gjorde mina läxor, fixade felen och försökte en andra gång.
Men jag glömde en viktig sak, och de påminde mig artigt om det:
Jag var inte tillräckligt uppmärksam och lade inte till en enhörning som en bekräftelse på att alla villkor var uppfyllda.
Ytterligare en tid gick, jag fick några fler kommentarer och tillagda ändringar, och äntligen såg jag en efterlängtad twit om att min PR hade accepterats.
Så här gjorde jag min första lista och började ta emot communityns pull-förfrågningar om att lägga till nya verktyg. Många av dem är redan inkluderade i Awesome Database Tools.
Om du har bra idéer till databaser – dela gärna med dig av dem. Jag tar också gärna emot feedback från dig, som pull-förfrågningar och stjärnor. Om du har några frågor om att göra dina egna listor, vänligen meddela mig.
Du kan nå författaren på [email protected].