Ten materiał był pierwotnie opublikowane na Habr.com po rosyjsku. Autor zezwolił na jego przetłumaczenie i opublikowanie w Codingsight.
Być może każdy ma gdzieś plik do przechowywania pewnych ekscytujących i przydatnych rzeczy, takich jak linki do artykułów, książek, repozytoriów, podręczników itp. Możesz używać zakładek w przeglądarce lub kartach, wciąż otwartych i czekających na Ciebie. Z biegiem czasu wszystko to nadmiernie się rozrasta, linki zostają zerwane, a materiały stają się przestarzałe.
Ale co by było, gdybyśmy mogli podzielić się tymi wnikliwymi klejnotami ze społecznością? Przesłać plik do GitHub? Wtedy twoje odkrycia przydałyby się komuś innemu. Poza tym łatwiej byłoby zachować aktualność pliku, aktualizując listę za pomocą starych dobrych żądań ściągnięcia.
Po to właśnie mamy projekt Awesome Lists.
Awesome Lists znajduje się w pierwszej dziesiątce repozytoriów GitHub, szczycąc się już 138 tysiącami „gwiazd”, a link do twoich prac może znaleźć się w głównym README, przyciągając w ten sposób ogromną publiczność. Jednak najpierw będziesz musiał trochę się wysilić. Tutaj chcę podzielić się moim doświadczeniem.
Nazywam się Maksim Gramin, programista Java i badacz baz danych w CROC, międzynarodowej firmie informatycznej z siedzibą w Moskwie. W tym artykule dowiesz się o niesamowitych listach i o tym, jak stworzyć swoje oficjalne niesamowite repozytorium.
O czym są niesamowite listy?
Ilekroć mam do czynienia z jakąś nową technologią lub językiem programowania, idę tam najpierw, szukając potrzebnej sekcji i odpowiednich list. Biorąc pod uwagę dużą i stale rosnącą liczbę „gwiazd”, nie jestem jedyną osobą, która ma takie podejście.
W rzeczywistości „Awesome Lists” to standardowy zwykły plik readme.md mieszkający w osobnym repozytorium. Zajmuje jednak 8 pozycję wśród wszystkich repozytoriów GitHub i zawiera inne listy poświęcone określonym tematom. Na przykład sekcja Języki programowania zawiera listy Awesome Python i Awesome Go, podczas gdy sekcja Front-End Development przechowuje liczne materiały dotyczące programowania w sieci Web. Wreszcie, co nie mniej ważne, jest sekcja Baza danych (porozmawiamy o tym nieco później).
Oczywiście zawartość nie ogranicza się wyłącznie do tematów technicznych i obejmuje również inne sekcje, takie jak Rozrywka i Gry. Możesz tam również znaleźć wiele ekscytujących rzeczy (byłem naprawdę zadowolony z listy fantastycznych fantazji).
Głównym wyróżnikiem projektu jest to, że wszystkimi tymi listami zarządza nie tylko autor, ale społeczność. Poza tym wszystkie są wykonane zgodnie z surowym Awesome Manifesto. Każda lista reprezentuje odrębną społeczność specjalistów, żyjących własnym życiem i otwartych na Twoje pull requesty, dzięki czemu będzie jeszcze lepsza. Co więcej, każdy może stworzyć własną listę na wypadek, gdyby jakiś temat nie został zbadany.
Za oryginalny pomysł i koordynację wszystkich tych rzeczy powinniśmy być wdzięczni legendarnemu Sindre Sorhusowi, pierwszemu człowiekowi na GitHub i autorowi ponad 1000 modułów npm. To on zaakceptuje Twoje prośby o ściągnięcie.
Jak zrobić niesamowitą listę
Jeśli nie znalazłeś odpowiedniej listy na potrzebny temat, to pierwszy znak, że powinieneś zrobić to sam! Opowiem Ci, jak to zrobić na przykładzie mojego własnego dzieła – Awesome Database Tools.
Projekt po projekcie miałem do czynienia z wszelkiego rodzaju bazami danych. W ten sposób zacząłem zarządzać niektórymi plikami, w których zebrałem różne przydatne narzędzia do pracy. Istniały różne migratory DB, IDE, panele administracyjne, narzędzia monitorujące itp., w tym te, z których już korzystałem lub które dopiero planowałem.
Udostępniłem ten plik moim kolegom z CROC i nie tylko, zachęcony widząc, jakie korzyści przyniosło wielu z nich. Potem chciałem więcej. Kiedy zauważyłem, że w sekcji Bazy danych brakowało listy poświęconej narzędziom, postanowiłem dodać swoją.
Czego do tego potrzebujesz?
- Zarejestruj standardowe repozytorium GitHub i nazwij je jak awesome-smth – w moim przypadku były to awesome-database-tools.
- Dostosuj listę do niesamowitych sformatuj za pomocą generatora-awesome-list, który wygeneruje wszystkie niezbędne pliki we właściwym formacie.
- Konfiguruj ciągłą integrację (CI) – awesome-lint i Travis CI pomogą nam kontrolować poprawność listy.
- Poczekaj 30 dni.
- Przejrzyj co najmniej 2 inne żądania ściągnięcia.
- Złóż żądanie ściągnięcia do głównego repozytorium i dodaj link do naszego własnego repozytorium. Ważne :Uważnie przeczytaj wszystkie liczne wymagania dotyczące nowej listy i pull requestów i dokładnie je przestrzegaj.
Moja pierwsza próba się nie powiodła.
Jednak po pewnym czasie zebrałem więcej materiałów, odrobiłem pracę domową, naprawiłem błędy i spróbowałem po raz drugi.
Ale zapomniałem o jednej ważnej rzeczy, a oni grzecznie mi o tym przypomnieli:
Nie byłem wystarczająco uważny i nie dodałem jednorożca jako potwierdzenia spełnienia wszystkich warunków.
Minęło trochę czasu, dostałem więcej uwag i dodałem poprawki, aż w końcu zobaczyłem długo oczekiwanego frajera, że mój PR został zaakceptowany.
W ten sposób stworzyłem swoją pierwszą listę i zacząłem otrzymywać od społeczności prośby o dodanie nowych narzędzi. Wiele z nich jest już zawartych w Awesome Database Tools.
Jeśli masz dobre pomysły na bazy danych – podziel się nimi. Chętnie też otrzymam od Ciebie informacje zwrotne, takie jak prośby o ściągnięcie i gwiazdki. Jeśli masz pytania dotyczące tworzenia własnych list, daj mi znać.
Możesz skontaktować się z autorem pod adresem [email protected].
