Zadbaj o pierwszą wizytę w repozytorium
Zanim udostępnisz link, otwórz repozytorium tak, jak osoba, która nigdy o nim nie słyszała. Pierwszy ekran powinien wyjaśniać problem, wskazywać odbiorcę i najkrótszą drogę do uzyskania wyniku. Zrzut ekranu pomaga w przypadku narzędzia wizualnego; dla biblioteki często bardziej przydatny jest niewielki przykład danych wejściowych i wyniku.
Dla przykładowego walidatora CSV opis „Sprawdzaj pliki CSV przed zaimportowaniem ich do bazy danych” mówi więcej niż „Potężny zestaw narzędzi do danych”. Dodaj do niego przykładowy niepoprawny plik, polecenie sprawdzające i uzyskany komunikat błędu.
- Umieść cel projektu i działający przykład przed długą listą funkcji.
- Podaj wymagania środowiska, kroki instalacji i znane ograniczenia.
- Dodaj linki do licencji, dokumentacji i miejsca zgłaszania problemów.
- Używaj trafnych tematów repozytorium, aby osoby przeglądające daną dziedzinę mogły znaleźć projekt.
Znajdź pierwszych właściwych odbiorców
Wybierz społeczność, w której ludzie już rozmawiają o problemie rozwiązywanym przez Twój projekt. Narzędzie do danych w Pythonie wymaga innego wprowadzenia niż narzędzie projektowe działające w przeglądarce. Opisz jeden konkretny przypadek użycia i wskaż, o jaką opinię prosisz. Zaznacz, że opiekujesz się projektem, i najpierw przeczytaj zasady publikowania w społeczności.
Zacznij od małej próby: popraw README, udostępnij jeden działający przykład w jednym odpowiednim miejscu i odpowiedz na pytania. Jeśli odbiorcy nie mogą zainstalować projektu, popraw to przed dodaniem kolejnych kanałów. Wielokrotne publikowanie tego samego linku nie rozwiązuje problemów z rozpoczęciem pracy.
Zaproponuj gwiazdkę po dostarczeniu czegoś przydatnego
Wystarczy krótka, opcjonalna zachęta po sekcji szybkiego startu: „Jeśli projekt jest dla Ciebie przydatny, możesz oznaczyć repozytorium gwiazdką, by łatwiej znaleźć je ponownie”. Instrukcje instalacji, dokumentacja i pomoc powinny być dostępne niezależnie od tego, czy ktoś przyzna gwiazdkę.
GitHubStart oferuje publiczny katalog do odkrywania projektów i wzajemnego wsparcia. Możesz dodać publiczne repozytorium bez logowania do GitHubStart, przeglądać inne projekty i wybrać te, które chcesz wesprzeć. Gwiazdkę nadal przyznajesz ręcznie po zalogowaniu do GitHub. Dodanie repozytorium nie gwarantuje określonej liczby gwiazdek ani gwiazdki w zamian.
Prowadź tygodniowy dziennik wniosków
Notuj datę, wprowadzoną zmianę, miejsce publikacji, otrzymane pytania i zastosowane poprawki. Porównuj gwiazdki z praktycznymi sygnałami, takimi jak udane instalacje, odtwarzalne zgłoszenia błędów i powracający współtwórcy. Wzrost po publikacji oznacza korelację, a nie dowód, że każda nowa gwiazdka pochodzi z tego wpisu.
Na przykład jeśli pięć osób pyta o konfigurację tokena, przenieś instrukcję konfiguracji nad przykład. Udostępnij tym osobom poprawioną wersję zamiast publikować kolejne ogólne ogłoszenie o premierze.
- Tydzień 1: sprawdź szybki start w czystym środowisku.
- Tydzień 2: przedstaw jeden przypadek użycia i odpowiedz na opinie.
- Tydzień 3: opublikuj poprawki i wyjaśnij zmiany.
- Tydzień 4: zachowaj kanał, który przyniósł przydatne rozmowy, i oceń pozostałe.
Częste pytania
Jak zdobyć pierwsze 100 gwiazdek GitHub?
Traktuj 100 jako etap, a nie obiecany wynik. Zacznij od użytecznego projektu, czytelnego README i właściwych odbiorców. Te same kroki sprawdzają się przy 5 i 500 gwiazdkach; potrzebny czas zależy od projektu i jego odbiorców.
Czy mogę przyznać gwiazdkę repozytorium GitHub bez logowania?
Publiczne repozytoria i GitHubStart można przeglądać bez konta w tej witrynie. Aby przyznać gwiazdkę, musisz samodzielnie zalogować się do GitHub. GitHubStart nie wykonuje tej czynności za Ciebie.
Czy więcej gwiazdek oznacza więcej użytkowników?
Niekoniecznie. Ktoś może zapisać repozytorium na później, nie instalując projektu. Obserwuj faktyczne wykorzystanie i opinie niezależnie od liczby gwiazdek.