Tento materiál byl původně zveřejněno na Habr.com v ruštině. Autor povolil její překlad a publikování na Codingsight.
Snad každý má někde soubor, kde si uchovává určité vzrušující a užitečné věci, jako jsou odkazy na články, knihy, úložiště, příručky atd. Můžete použít záložky v prohlížeči nebo kartách, které jsou stále otevřené a čekají na vás. Postupem času to všechno nadměrně roste, odkazy se přerušují a materiály zastarávají.
Ale co kdybychom mohli sdílet tyto cenné skvosty s komunitou? Nahrát soubor na GitHub? Pak by vaše poznatky byly užitečné pro někoho jiného. Kromě toho by bylo snazší udržovat soubor aktuální a seznam aktualizovat pomocí starých dobrých požadavků na stažení.
K tomu máme projekt Awesome Lists.
Awesome Lists patří mezi 10 nejlepších úložišť GitHub a může se pochlubit již 138 tisíci „hvězdami“ a odkaz na vaše díla se může dostat do kořenového souboru README, čímž přiláká obrovské publikum. Nejprve však budete muset vynaložit určité úsilí. Zde se chci podělit o své zkušenosti.
Jsem Maksim Gramin, vývojář Java a výzkumník databází v CROC, mezinárodní IT společnosti s centrálou v Moskvě. Tento článek vám řekne o úžasných seznamech a o tom, jak vytvořit oficiální úžasné repo.
O čem jsou úžasné seznamy?
Kdykoli se musím vypořádat s nějakou novou technologií nebo programovacím jazykem, zajdu nejprve tam a hledám potřebnou sekci a příslušné seznamy. Vzhledem k velkému a stále rostoucímu počtu „hvězd“ nejsem jediný, kdo má takový přístup.
Ve skutečnosti je „Awesome Lists“ standardní prostý readme.md žijící v samostatném úložišti. Mezi všemi repozitáři GitHub však zaujímá 8. pozici a zahrnuje další seznamy věnované určitým tématům. Například sekce Programming Languages obsahuje seznamy Awesome Python a Awesome Go, zatímco sekce Front-End Development uchovává četné materiály pro vývoj webu. V neposlední řadě je zde sekce Databáze (o ní si povíme trochu později).
Obsah se samozřejmě neomezuje pouze na technické předměty a zahrnuje i další sekce, jako je Zábava a hry. Také tam můžete najít mnoho vzrušujících věcí (se seznamem super-fantasy jsem byl opravdu spokojený).
Hlavním rozdílem projektu je, že všechny tyto seznamy nespravuje pouze autor, ale komunita. Kromě toho jsou všechny vyrobeny podle přísného Awesome Manifesto. Každý seznam představuje samostatnou komunitu specialistů, kteří si žijí vlastním životem a jsou otevření vašim žádostem o stažení, díky čemuž bude ještě lepší. Navíc si každý může vytvořit svůj vlastní seznam v případě, že některému tématu chybí prozkoumání.
Za originální nápad a koordinaci všech těchto věcí bychom měli být vděční legendárnímu Sindre Sorhusovi, prvnímu muži na GitHubu a autorovi více než 1000 npm-modulů. Je to on, kdo přijme vaše žádosti o stažení.
Jak vytvořit úžasný seznam
Pokud jste nenašli správný seznam pro potřebné téma, je to první známka toho, že byste to měli udělat sami! Řeknu vám, jak na to, na příkladu mého vlastního výtvoru – Awesome Database Tools.
Projekt od projektu, musel jsem se vypořádat se všemi druhy databází. Začal jsem tedy spravovat některé soubory, kde jsem shromažďoval různé užitečné nástroje pro práci. Existovaly různé DB-migrátory, IDE, administrátorské panely, monitorovací nástroje atd., včetně těch, které jsem již používal nebo jsem to plánoval.
Sdílel jsem tento soubor se svými kolegy v CROC i mimo něj, povzbuzen tím, že jsem viděl, jak to mnoha z nich prospělo. Pak jsem chtěl víc. Když jsem si všiml, že v sekci Databáze chybí seznam věnovaný nástrojům, rozhodl jsem se přidat svůj.
Co k tomu potřebujete?
- Zaregistrujte si standardní GitHub-repo a pojmenujte ho jako úžasné-něco – v mém případě to byly úžasné-databázové nástroje.
- Upravte seznam na úžasný formát pomocí generátoru-awesome-list, který vygeneruje všechny potřebné soubory ve správném formátu.
- Nakonfigurujte kontinuální integraci (CI) – awesome-lint a Travis CI nám pomohou kontrolovat platnost seznamu.
- Počkejte 30 dní.
- Zkontrolujte alespoň 2 další žádosti o stažení.
- Zadejte požadavek na stažení hlavního úložiště a přidejte odkaz na naše vlastní úložiště. Důležité :Pečlivě si přečtěte všechny četné požadavky na nový seznam a požadavky na stažení a přesně je dodržujte.
Můj první pokus nevyšel.
Po nějaké době jsem však shromáždil další materiály, udělal domácí úkol, opravil chyby a zkusil to podruhé.
Ale zapomněl jsem na jednu zásadní věc a oni mi to slušně připomněli:
Nebyl jsem dostatečně pozorný a nepřidal jsem jednorožce jako potvrzení splnění všech podmínek.
Uplynul nějaký čas, dostal jsem další poznámky a přidal jsem pozměňovací návrhy a nakonec jsem uviděl dlouho očekávaný cvrkot, že moje PR bylo přijato.
Takto jsem vytvořil svůj první seznam a začal jsem dostávat žádosti komunity o přidání nových nástrojů. Mnohé z nich jsou již součástí Awesome Database Tools.
Pokud máte dobré nápady na databáze – neváhejte je sdílet. Také od vás rád získám zpětnou vazbu, jako jsou žádosti o stažení a hvězdičky. Pokud máte nějaké dotazy ohledně vytváření vlastních seznamů, dejte mi prosím vědět.
Autora můžete kontaktovat na adrese [email protected].