Този материал първоначално е бил публикувано на Habr.com на руски. Авторът разреши да бъде преведен и публикуван в Codingsight.
Може би всеки има някъде файл, в който да съхранява някои вълнуващи и полезни неща, като връзки към статии, книги, хранилища, ръководства и т.н. Може да използвате отметки в браузър или раздели, които все още са отворени и ви чакат. С течение на времето всичко това нараства прекомерно, връзките се развалят и материалите стават остарели.
Но какво, ако можем да споделим тези проницателни скъпоценни камъни с общността? Да качите файл в GitHub? Тогава вашите открития биха били полезни за някой друг. Освен това би било по-лесно да поддържате файла актуален заедно, като актуализирате списъка чрез добрите стари заявки за изтегляне.
Това е, за което имаме проекта Awesome Lists.
Awesome Lists е сред топ 10 на GitHub хранилища, вече може да се похвали със 138 000 „звезди“, а връзка към вашите произведения може да го направи до основния README, като по този начин привлече огромна публика. Въпреки това, първо ще трябва да положите малко усилия. Тук искам да споделя моя опит.
Аз съм Максим Грамин, Java разработчик и изследовател на бази данни в КРОК, международна ИТ компания със седалище в Москва. Тази статия ще ви разкаже за страхотните списъци и как да направите своето официално страхотно репо.
За какво са страхотни списъци?
Винаги, когато трябва да се справя с някаква нова технология или език за програмиране, първо отивам там, търся необходимия раздел и подходящи списъци. Предвид големия и непрекъснато нарастващ брой „звезди“, аз не съм единственият човек с такъв подход.
Всъщност „Страхотни списъци“ е стандартен обикновен readme.md, живеещ в отделно хранилище. Въпреки това, той заема 8 позиция сред всички хранилища на GitHub и включва други списъци, посветени на определени теми. Например секцията Езици за програмиране има списъци Awesome Python и Awesome Go, докато секцията Front-End Development съхранява множество материали за уеб разработка. Не на последно място, има раздел База данни (ще говорим за него малко по-късно).
Разбира се, съдържанието не се ограничава само до технически теми и включва и други раздели, като забавления и игри. Там също можете да намерите много вълнуващи неща (много бях доволен от списъка с страхотни фантазии).
Основното отличие на проекта е, че всички тези списъци се управляват не само от автора, но и от общността. Освен това всички те са направени според стриктен Страхотен манифест. Всеки списък представлява отделна общност от специалисти, които живеят свой собствен живот и са отворени за вашите заявки за изтегляне, което ще го направи още по-добър. Освен това всеки може да създаде свой собствен списък, в случай че някои теми не могат да бъдат проучени.
За оригиналната идея и координацията на всичко това трябва да сме благодарни на легендарния Синдре Сорхус, първият човек на GitHub и автор на 1000+ npm модула. Той е този, който ще приеме вашите заявки за изтегляне.
Как да направим страхотен списък
Ако не сте намерили правилния списък за необходимата тема, това е първият знак, че трябва да го направите сами! Ще ви кажа как да го направите с примера на моето собствено творение – Страхотни инструменти за бази данни.
Проект по проект трябваше да се справя с всякакви бази данни. Така започнах да управлявам някои файлове, където събрах различни полезни инструменти за работа. Имаше различни DB-мигратори, IDE, административни панели, инструменти за наблюдение и т.н., включително тези, които вече използвах или само планирах.
Споделих този файл с моите колеги от КРОК и извън него, насърчен, като видях как е от полза за много от тях. Тогава исках още. Когато забелязах, че в секцията Бази данни липсва списък, посветен на инструментите, реших да добавя моя.
Какво ви трябва за това?
- Регистрирайте стандартно GitHub-repo и го наречете като awesome-smth – в моя случай това беше awesome-database-tools.
- Коригирайте списъка до страхотно формат с помощта на generator-awesome-list, който ще генерира всички необходими файлове в правилния формат.
- Конфигуриране на непрекъсната интеграция (CI) – awesome-lint и Travis CI ще ни помогне да контролираме валидността на списъка.
- Изчакайте 30 дни.
- Прегледайте поне 2 други заявки за изтегляне.
- Направете заявка за изтегляне към основното репо и добавете връзка към нашето собствено репо. Важно :Прочетете внимателно всички многобройни изисквания към новия списък и заявки за изтегляне и ги следвайте точно.
Първият ми опит не беше успешен.
След известно време обаче събрах още материали, направих си домашното, поправих грешките и опитах втори път.
Но забравих едно важно нещо и те ми напомниха учтиво:
Не бях достатъчно внимателен и не добавих еднорог като потвърждение, че всички условия са изпълнени.
Измина още време, получих още няколко забележки и допълнения и накрая видях дългоочакван твит, че моят PR е приет.
Ето как направих първия си списък и започнах да получавам заявки за изтегляне на общността за добавяне на нови инструменти. Много от тях вече са включени в Awesome Database Tools.
Ако имате добри идеи за бази данни – не се колебайте да ги споделите. Освен това ще се радвам да получа обратна връзка от вас, като заявки за изтегляне и звезди. Ако имате въпроси относно съставянето на свои собствени списъци, моля, уведомете ме.
Можете да се свържете с автора на [email protected].
