Odznaky GitHub mohou zvýšit čitelnost úložiště tím, že uživatelům poskytnou rychlý způsob, jak zachytit metriky úložiště. Do souboru README.md lze vložit odznaky, které objasní důležitost a nezbytnost vašeho projektu pro ostatní vývojáře. Výsledkem je, že čtenáři získají opravdu rychlou představu o úložišti kontrolou připojených odznaků.
Na internetu je k dispozici mnoho odznaků GitHub, zde je pět nejinformativnějších odznaků, které můžete zahrnout do souboru README.md. Pro každý uvedený odznak je uveden ekvivalentní kód Markdown.
Co pro vás mohou odznaky GitHub udělat?
Přidání odznaků GitHub do vašeho úložiště se může zdát triviální, ale ve skutečnosti je to neuvěřitelně užitečné. Vše, co musíte udělat, je importovat kód Markdown ze zdroje do souboru README.md.
Když jsem vytvořil své úložiště Python Programming GitHub, vynechal jsem odznaky. Moje nevyzdobené úložiště mělo správný obsah, ale nevynikalo. Z tohoto důvodu úložiště získalo velmi malý provoz (jedineční návštěvníci).
Příbuzný: Jak vytvořit úložiště GitHub
Chcete sdílet své vývojové projekty online? Zde je návod, jak začít s prvním úložištěm Github.
Po přidání dalších odznaků do mého úložiště jsem viděl automatický nárůst externích návštěvníků (z 5 na 767) měsíčně (zobrazte své jedinečné návštěvníky v Statistiky> Provoz ve vašem úložišti.)
Moje doručená pošta byla plná komentářů o tom, jak dobře moje úložiště vyčnívalo z jiných úložišť programování Pythonu kvůli všem odznakům. Jednoduchý odznak GitHub může zcela změnit vzhled vašeho úložiště.
Mějte to vždy na paměti: odznak má hodnotu 1000 řádků kódu.
Odznak Statistiky GitHubu ukazuje celkový počet hvězdiček, závazků, žádostí o vydání, problémů a příspěvků vašeho úložiště GitHub.
- Hvězdy: Uživatelé ukládají úložiště GitHub (jako záložky). To znamená, že uživatel má zájem a přeje si mít aktuální přehled o uloženém úložišti. Úložiště s hvězdičkou však nelze upravit.
- Závazky: Uložení změny v úložišti se označuje jako potvrzení. K potvrzení jsou připojeny různé podrobnosti, obsah, zpráva (popis), jméno autora a časové razítko.
- Pull Request: Žádost o vytažení informuje ostatní o vylepšeních, která jste odeslali do jiného úložiště GitHub, kromě vašeho. Pull Request často označujeme jako srdce GitHub Collaboration.
- Problémy: Problémy GitHub se používají k získání zpětné vazby od uživatelů, sledování nápadů, vylepšení a výpisu chyb hlášených do úložiště.
- Příspěvek: Příspěvky GitHub označují počet příspěvků, které byly provedeny do jiných úložišť. Příspěvek lze poskytnout pomocí žádosti o přijetí žádosti.
Chcete-li do svého úložiště přidat odznak Statistiky GitHub, vložte do svého souboru README.md níže uvedený kód Markdown.
! [Statistiky vašeho úložiště] ( https://github-readme-stats.vercel.app/api? username = Your_GitHub_Username & show_icons = true)
Ujistěte se, že jste změnili uživatelské jméno = hodnotu k uživatelskému jménu vašeho GitHubu. Odznak Statistiky GitHub také poskytuje hodnosti, jako například S + (horní 1%), S (horní 25%), A ++ (horní 45%), A + (horní 60%) a B + (všichni). Čím vyšší jsou vaše statistiky, tím lepší je vaše hodnocení.
Jak název napovídá, odznak Nejpoužívanější jazyky zobrazuje nejběžnější jazyky používané v GitHubu. Jedná se o metriku GitHub, z nichž jazyky jako HTML, CSS, JavaScript, Python, Go, a další mají nejvíce kódu na GitHubu. Jazyky jsou seřazeny v sestupném pořadí.
Příbuzný: Který programovací jazyk byste se měli naučit?
Chcete-li do svého úložiště přidat odznak Nejpoužívanější jazyky, vložte níže uvedený odkaz do souboru README.md.
! [Statistiky vašeho úložiště] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Your_GitHub_Username&theme=blue-green)
Jedinou nevýhodou tohoto odznaku je, že nebude uvádět Markdown jako nejčastěji používaný jazyk.
Odznak Přispěvatelé zobrazuje všechny operace, jako je dodatky, vypuštění, a zavazuje které byly provedeny ve vašich úložištích. Když sloučíte požadavek na stažení do svého úložiště, bude osoba, která požadavek vytvořila, přidána jako přispěvatel. Je opravdu dobrým zvykem připočítat přispěvatelům, kteří investovali svůj čas do poskytnutí aktualizace do vašeho úložiště.
Odznak přispěvatelů lze vygenerovat pomocí přispěvatelů-img, webové aplikace, která generuje obrázek pro zobrazení seznamu přispěvatelů.
Generování image přispěvatele je docela triviální. Přejděte na web přispěvatelů-img a vložte název vašeho úložiště spolu s vaší uživatelské jméno vygenerovat URL. Nebo můžete obrázek jednoduše vložit níže uvedeným kódem Markdown.
! [Obrázek přispěvatelů GitHub] ( https://contrib.rocks/image? repo = Your_GitHub_Username / Your_GitHub_Repository_Name)
Generátor náhodných vtipů vygeneruje technický vtip ve formě otázek a odpovědí. Například, "Co je to počítačový virus? Terminální nemoc”.
Chcete-li použít odznak, musíte vložit kód Markdown do souboru README.md, jak je uvedeno níže.
## 😂 Zde je náhodný vtip, který vás rozesměje!
! [Vtipná karta] ( https://readme-jokes.vercel.app/api)
Odznak Počítadlo zobrazení profilu zobrazuje počet zobrazení vašeho profilu GitHub ve vašem profilu. Chcete-li vygenerovat tento odznak, vložte následující kód Markdown:
! [Počítadlo zobrazení profilu] ( https://komarev.com/ghpvc/?username=Your_GitHub_Username)
Chcete-li vygenerovat počet zobrazení vašeho úložiště, můžete použít HITS (Jak idioti sledují úspěch) odznak. Je to jednoduchý způsob, jak zjistit, kolik lidí vaši návštěvu navštívilo GitHub úložiště:
! [Hity] ( https://hitcounter.pythonanywhere.com/count/tag.svg? url = Paste_Your_GitHub_Repository_Link_Here)
Nevýhodou čítače Zobrazení profilu i HITS je však to, že nezobrazují počet zobrazení s jedinečnými ID. Pokaždé, když znovu načtete prohlížeč / úložiště, počty se zvýší. Obnovením stránky lze snadno získat více zobrazení.
Plná implementace odznaků GitHub
Jako příklad jsem použil své úložiště GitHub. Pro vygenerování odznaků se doporučuje přidat tyto kódy do určeného souboru README.md. Pokud ve svém úložišti GitHub nemáte soubor README.md, je nejlepší volbou ruční vytvoření.
# 5 nejlepších odznaků, které posunou vaše úložiště GitHub na další úroveň
## 1. Statistiky GitHub
! [Statistiky vašeho úložiště] ( https://github-readme-stats.vercel.app/api? uživatelské jméno = Tanu-N-Prabhu & show_icons = true)
## 2. Nejpoužívanější jazyky
! [Statistiky vašeho úložiště] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Tanu-N-Prabhu&theme=blue-green)
## 3. Odznak přispěvatelů
! [Statistiky vašeho úložiště] ( https://contrib.rocks/image? repo = Tanu-N-Prabhu / Python)
## 4. Generátor náhodných vtipů
! [Vtipná karta] ( https://readme-jokes.vercel.app/api)
## 5. Počítadlo zobrazení profilu
! [Počítadlo zobrazení profilu] ( https://komarev.com/ghpvc/?username=Tanu-N-Prabhu)
### Počítadlo zobrazení úložiště - HITS
! [Hity] ( https://hitcounter.pythonanywhere.com/count/tag.svg? url = https://github.com/Tanu-N-Prabhu/Python)
Není nutné spouštět nebo spouštět výše uvedený fragment kódu ve vašem souboru README.md. V okamžiku, kdy uložíte soubor s příponou (.md), GitHub automaticky vykreslí výstup a změny by se přímo projevily ve vašem úložišti.
K dispozici je více odznaků GitHub
Nyní, když víte, jak přidat odznaky GitHub do svého úložiště, je to skvělá volba pro vývojáře a jednotlivce, kteří mohou pomocí těchto odznaků zvýšit čitelnost svých úložišť. Není to tak těžké - vše, co musíte udělat, je vložit několik řádků kódu Markdown pro vygenerování odznaků.
Čím více odznaků vložíte do svého úložiště, tím více pozornosti získáte. Jediný odznak bude schopen poskytovat užitečné informace, pokud jde o statistiky, stav a metriky.
Chcete se seznámit se softwarem na GitHubu? Zde je návod, jak se dostat na východ pomocí efektivního nástroje GitHub Desktop.
- Programování
- Snížení
- GitHub
Přihlaste se k odběru našeho zpravodaje
Připojte se k našemu zpravodaji s technickými tipy, recenzemi, bezplatnými elektronickými knihami a exkluzivními nabídkami!
Ještě jeden krok…!
V e-mailu, který jsme vám právě poslali, potvrďte svou e-mailovou adresu.