Odznaki GitHub mogą zwiększyć czytelność repozytorium, zapewniając użytkownikom szybki sposób przechwytywania metryk repozytorium. Odznaki można osadzić w pliku README.md, aby wyjaśnić znaczenie i konieczność projektu innym programistom. W rezultacie czytelnicy szybko uzyskują wyobrażenie o repozytorium, sprawdzając załączone plakietki.
W Internecie dostępnych jest wiele odznak GitHub. Oto pięć najważniejszych znaczków, które należy umieścić w pliku README.md. Dla każdej wymienionej odznaki dostarczany jest równoważny kod Markdown.
Co mogą dla Ciebie zrobić odznaki GitHub?
Dodanie znaczków GitHub do repozytorium może wydawać się banalne, ale w rzeczywistości jest niezwykle przydatne. Wszystko, co musisz zrobić, to zaimportować kod Markdown ze źródła do pliku README.md.
Kiedy tworzyłem repozytorium GitHub do programowania w Pythonie, pominąłem odznaki. Moje pozbawione ozdób repozytorium miało odpowiednią zawartość, ale się nie wyróżniało. Z tego powodu repozytorium zyskało bardzo mały ruch (unikalni goście).
Związane z: Jak utworzyć repozytorium GitHub
Chcesz udostępniać swoje projekty programistyczne online? Oto jak rozpocząć korzystanie z pierwszego repozytorium Github.
Po dodaniu kolejnych identyfikatorów do mojego repozytorium zauważyłem automatyczny wzrost liczby odwiedzających z zewnątrz (z 5 do 767) miesięcznie (wyświetlaj swoich unikalnych użytkowników w Statystyki> Ruch w repozytorium).
Moja skrzynka odbiorcza była wypełniona komentarzami na temat tego, jak dobrze moje repozytorium wyróżniało się na tle innych repozytoriów programowania w języku Python - wszystko dzięki znaczkom. Prosta plakietka GitHub może całkowicie zmienić wygląd Twojego repozytorium.
Zawsze miej to na uwadze: odznaka jest warta 1000 linii kodu.
Odznaka GitHub Stats pokazuje całkowitą liczbę gwiazdek, zatwierdzeń, żądań ściągnięcia, problemów i wkładów w repozytorium GitHub.
- Gwiazdy: Użytkownicy zapisują repozytoria GitHub (np. Tworzenie zakładek). Oznacza to, że użytkownik jest zainteresowany i chce być na bieżąco z zapisanym repozytorium. Jednak repozytorium oznaczonego gwiazdką nie można edytować.
- Commits: Zapisanie zmiany w repozytorium jest nazywane zatwierdzeniem. Różne szczegóły są dołączane do zatwierdzenia, treść, wiadomość (opis), nazwisko autora i sygnatura czasowa.
- Prośba o pociągnięcie: Pull request informuje innych o ulepszeniach, które zostały przez Ciebie przeniesione do innego repozytorium GitHub, z wyjątkiem Twojego. Często odnosimy się do Pull Request jako do serca współpracy GitHub.
- Zagadnienia: Problemy z GitHub są używane do uzyskiwania opinii użytkowników, śledzenia pomysłów, ulepszeń i wyświetlania listy błędów zgłoszonych do repozytorium.
- Wkład: Wkłady na GitHub wskazują liczbę wkładów, które zostały wniesione do innych repozytoriów. Pomoc można wnieść za pomocą pull requesta.
Aby dodać odznakę GitHub Stats do swojego repozytorium, umieść poniższy kod Markdown w pliku README.md.
! [Statystyki twojego repozytorium] ( https://github-readme-stats.vercel.app/api? nazwa użytkownika = Your_GitHub_Username & show_icons = true)
Upewnij się, że zmieniłeś nazwa użytkownika = wartość do nazwy użytkownika GitHub. Odznaka GitHub Stats zapewnia również rangi, takie jak S + (u góry 1%), S (u góry 25%), A ++ (u góry 45%), A + (u góry 60%) i B + (u wszystkich). Im wyższe statystyki, tym lepszy ranking.
Jak sama nazwa wskazuje, znaczek Najczęściej używane języki wyświetla najpopularniejsze języki używane w GitHub. Jest to metryka GitHub określająca, które języki, takie jak HTML, CSS, JavaScript, Python, Go, i nie tylko mają najwięcej kodu w GitHub. Języki są wymienione w porządku malejącym.
Związane z: Jakiego języka programowania powinieneś się nauczyć?
Aby dodać odznakę najczęściej używanych języków do swojego repozytorium, umieść poniższy Markdown w swoim pliku README.md.
! [Statystyki twojego repozytorium] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Your_GitHub_Username&theme=blue-green)
Jedyną wadą tej plakietki jest to, że nie wymienia ona języka Markdown jako najczęściej używanego języka.
Odznaka współautorów wyświetla wszystkie operacje, takie jak wzbogacenie, skreślenia, i zatwierdza które zostały wykonane na twoich repozytoriach. Po scaleniu żądania ściągnięcia do repozytorium osoba, która utworzyła żądanie, zostanie dodana jako współautor. Naprawdę dobrym zwyczajem jest uznawanie współautorów, którzy zainwestowali swój czas w dostarczenie aktualizacji do repozytorium.
Plakietkę współpracownika można wygenerować za pomocą aplikacji sieciowej contributors-img, która generuje obraz w celu wyświetlenia listy współpracowników.
Generowanie obrazu współautora jest dość trywialne. Przejdź do witryny internetowej contributors-img i wklej plik nazwa twojego repozytorium wraz z twoją Nazwa Użytkownika do wygenerowania adresu URL. Alternatywnie, po prostu umieść kod Markdown podany poniżej, aby uzyskać obraz.
! [Obraz współtwórców GitHub] ( https://contrib.rocks/image? repo = Your_GitHub_Username / Your_GitHub_Repository_Name)
Generator losowych żartów wygeneruje żart techniczny w postaci pytań i odpowiedzi. Na przykład, "Co to jest wirus komputerowy? Nieuleczalna choroba”.
Aby użyć odznaki, musisz osadzić kod Markdown w pliku README.md, jak pokazano poniżej.
## 😂 Oto losowy żart, który Cię rozśmieszy!
! [Karta żartów] ( https://readme-jokes.vercel.app/api)
Odznaka licznika wyświetleń profilu pokazuje, ile razy Twój profil GitHub był oglądany w Twoim profilu. Aby wygenerować tę plakietkę, umieść następujący kod Markdown:
! [Licznik wyświetleń profilu] ( https://komarev.com/ghpvc/?username=Your_GitHub_Username)
Aby wygenerować liczbę wyświetleń repozytorium, możesz użyć HITS (Jak idioci śledzą sukcesy) odznaka. To prosty sposób na sprawdzenie, ile osób odwiedziło Twój GitHub magazyn:
! [Trafienia] ( https://hitcounter.pythonanywhere.com/count/tag.svg? url = Paste_Your_GitHub_Repository_Link_Here)
Wadą zarówno licznika wyświetleń profilu, jak i HITS jest to, że nie wyświetlają liczby wyświetleń z unikalnymi identyfikatorami. Za każdym razem, gdy przeładujesz przeglądarkę / repozytorium, liczby będą zwiększane. Możesz łatwo uzyskać więcej wyświetleń, odświeżając stronę.
Pełne wdrożenie znaczków GitHub
Jako przykładu użyłem mojego repozytorium GitHub. Aby wygenerować identyfikatory, zaleca się dodanie tych kodów do wyznaczonego pliku README.md. Jeśli nie masz pliku README.md w repozytorium GitHub, najlepszym rozwiązaniem jest utworzenie go ręcznie.
# 5 najlepszych odznak, które przeniosą Twoje repozytorium GitHub na wyższy poziom
## 1. Statystyki GitHub
! [Statystyki twojego repozytorium] ( https://github-readme-stats.vercel.app/api? nazwa użytkownika = Tanu-N-Prabhu & show_icons = prawda)
## 2. Najczęściej używane języki
! [Statystyki twojego repozytorium] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Tanu-N-Prabhu&theme=blue-green)
## 3. Plakietka współpracownika
! [Statystyki twojego repozytorium] ( https://contrib.rocks/image? repo = Tanu-N-Prabhu / Python)
## 4. Generator losowych żartów
! [Karta żartów] ( https://readme-jokes.vercel.app/api)
## 5. Licznik wyświetleń profilu
! [Licznik wyświetleń profilu] ( https://komarev.com/ghpvc/?username=Tanu-N-Prabhu)
### Licznik wyświetleń repozytorium - HITS
! [Trafienia] ( https://hitcounter.pythonanywhere.com/count/tag.svg? url = https://github.com/Tanu-N-Prabhu/Python)
Nie ma potrzeby wykonywania ani uruchamiania powyższego fragmentu kodu znacznika w pliku README.md. W momencie zapisania pliku z rozszerzeniem (.md), GitHub automatycznie wyrenderuje wynik, a zmiany zostaną bezpośrednio odzwierciedlone w repozytorium.
Więcej dostępnych znaczków GitHub
Teraz, gdy wiesz, jak dodać znaczki GitHub do swojego repozytorium, jest to świetna opcja dla programistów i osób, które mogą używać tych plakietek, aby zwiększyć czytelność swoich repozytoriów. Nie jest to takie trudne - wszystko, co musisz zrobić, to osadzić kilka wierszy kodu Markdown, aby wygenerować odznaki.
Im więcej odznak umieścisz w swoim repozytorium, tym więcej uwagi otrzymasz. Pojedyncza plakietka będzie w stanie dostarczyć użytecznych informacji w zakresie statystyk, stanu i metryk.
Chcesz uporać się z oprogramowaniem na GitHubie? Oto, jak dotrzeć na wschód dzięki usprawnionemu narzędziu GitHub Desktop.
- Programowanie
- Obniżka cen
- GitHub
Zapisz się do naszego newslettera
Dołącz do naszego biuletynu, aby otrzymywać wskazówki techniczne, recenzje, bezpłatne e-booki i ekskluzywne oferty!
Jeszcze jeden krok…!
Potwierdź swój adres e-mail w wiadomości e-mail, którą właśnie wysłaliśmy.