Odznaky GitHub môžu zvýšiť čitateľnosť úložiska tým, že používateľom poskytujú rýchly spôsob zaznamenávania metrík úložiska. Do súboru README.md môžete vložiť odznaky, aby ste objasnili dôležitosť a nevyhnutnosť vášho projektu pre ostatných vývojárov. Vďaka tomu získajú čitatelia skutočne rýchlu predstavu o úložisku kontrolou priložených odznakov.

Na internete je k dispozícii veľa odznakov GitHub. Tu je päť najinformatívnejších odznakov, ktoré môžete zahrnúť do súboru README.md. Pre každý uvedený odznak je uvedený ekvivalentný kód Markdown.

Čo môžu pre vás odznaky GitHub urobiť?

Pridanie odznakov GitHub do vášho úložiska sa môže javiť ako triviálne, ale v skutočnosti je to neuveriteľne užitočné. Všetko, čo musíte urobiť, je importovať kód Markdown zo zdroja do súboru README.md.

Keď som vytvoril svoje úložisko GitHub Programming Python, vynechal som odznaky. Moje nevyzdobené úložisko malo správny obsah, ale nevyčnievalo. Z tohto dôvodu úložisko získalo veľmi malú premávku (jedineční návštevníci).

instagram viewer

Súvisiace: Ako vytvoriť úložisko GitHub

Ako vytvoriť prvé úložisko na Githube

Chcete zdieľať svoje vývojové projekty online? Tu je postup, ako začať s prvým úložiskom Github.

Po pridaní ďalších odznakov do môjho úložiska som zaznamenal automatický nárast externých návštevníkov (z 5 na 767) mesačne (pozrite si svojich jedinečných návštevníkov v Štatistiky> Premávka vo vašom úložisku.)

Moja doručená pošta bola plná komentárov o tom, ako dobre moje úložisko vyniklo oproti ostatným úložiskám programovania Pythonu kvôli odznakom. Jednoduchý odznak GitHub môže úplne zmeniť vzhľad vášho úložiska.

Majte to vždy na pamäti: odznak má hodnotu 1 000 riadkov kódu.

Odznak Štatistiky GitHubu demonštruje celkový počet hviezdičiek, záväzkov, žiadostí o stiahnutie, problémov a príspevkov vášho úložiska GitHub.

  1. Hviezdy: Používatelia ukladajú úložiská GitHub (napríklad záložky). To naznačuje, že používateľ má záujem a želá si mať aktuálny stav uloženého úložiska. Úložisko s hviezdičkou však nie je možné upraviť.
  2. Zaviaže: Uloženie zmeny v úložisku sa označuje ako Commit. K potvrdeniu sú pripojené rôzne podrobnosti, obsah, správa (popis), meno autora a časová pečiatka.
  3. Pull Request: Žiadosť o stiahnutie informuje ostatných o vylepšeniach, ktoré ste presunuli do iného úložiska GitHub, okrem vášho. Pull Request často označujeme ako srdce GitHub Collaboration.
  4. Problémy: Problémy GitHub sa používajú na získanie spätnej väzby od používateľov, sledovanie nápadov, vylepšení a zoznam chýb hlásených do úložiska.
  5. Príspevok: Príspevky GitHub označujú počet príspevkov, ktoré boli poskytnuté do iných archívov. Príspevok je možné poskytnúť pomocou žiadosti o stiahnutie.

Ak chcete pridať odznak Štatistiky GitHubu do svojho úložiska, vložte do svojho súboru README.md nižšie uvedený kód Markdown.

! [Štatistiky vášho úložiska] ( https://github-readme-stats.vercel.app/api? username = Your_GitHub_Username & show_icons = true)

Nezabudnite zmeniť používateľské meno = hodnotu k používateľskému menu vášho GitHubu. Odznak Štatistiky GitHubu tiež poskytuje hodnosti ako napr S + (horných 1%), S (horných 25%), A ++ (horných 45%), A + (horných 60%) a B + (všetkých). Čím vyššie sú vaše štatistiky, tým lepšie je vaše hodnotenie.

Ako už názov napovedá, odznak Najpoužívanejšie jazyky zobrazuje najbežnejšie jazyky používané v GitHub. Je to metrika GitHub, z ktorých jazykov ako napr HTML, CSS, JavaScript, Python, Go, a ďalšie majú najviac kódu na GitHub. Jazyky sú zoradené zostupne.

Súvisiace: Ktorý programovací jazyk by ste sa mali naučiť?

Ak chcete do svojho úložiska pridať odznak Najpoužívanejšie jazyky, vložte do svojho súboru README.md značku Markdown nižšie.

! [Štatistiky vášho úložiska] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Your_GitHub_Username&theme=blue-green)

Jedinou nevýhodou tohto odznaku je, že nebude uvádzať Markdown ako najbežnejšie používaný jazyk.

Odznak Prispievatelia zobrazuje všetky operácie ako napr prílohy, vypusteniaa zaviaže ktoré sa vykonali vo vašich úložiskách. Keď zlúčite žiadosť o načítanie do svojho úložiska, jednotlivec, ktorý vytvoril požiadavku, bude pridaný ako prispievateľ. Je naozaj dobrým zvykom pripísať prispievateľom, ktorí investovali svoj čas do poskytnutia aktualizácie vášmu úložisku, kredit.

Odznak prispievateľov je možné vygenerovať pomocou prispievateľa-img, webovej aplikácie, ktorá generuje obrázok na zobrazenie zoznamu prispievateľov.

Generovanie obrazu prispievateľa je dosť malicherné. Prejdite na web prispievateľov-img a prilepte názov vášho úložiska spolu s tvojím používateľské meno na vygenerovanie URL. Prípadne jednoducho vložte obrázok Markdown uvedený nižšie, aby ste získali obrázok.

! [Obrázok prispievateľov GitHub] ( https://contrib.rocks/image? repo = Vaše_GitHub_Užívateľské meno / Vaše_GitHub_Repository_Name)

Generátor náhodných vtipov vygeneruje technický vtip vo forme otázok a odpovedí. Napríklad „Čo je to počítačový vírus? Terminálna choroba”.

Ak chcete použiť tento znak, musíte vložiť kód Markdown do svojho súboru README.md, ako je uvedené nižšie.

## 😂 Tu je náhodný vtip, ktorý vás rozosmeje!
! [Vtipná karta] ( https://readme-jokes.vercel.app/api)

Odznak Počítadlo zobrazenia profilu zobrazuje počet zobrazení vášho profilu GitHub vo vašom profile. Na vygenerovanie tohto odznaku vložte nasledujúci kód Markdown:

! [Počítadlo zobrazenia profilu] ( https://komarev.com/ghpvc/?username=Your_GitHub_Username)

Na vygenerovanie počtu zobrazení vášho úložiska môžete použiť HITS (Ako idioti sledujú úspech) odznak. Je to jednoduchý spôsob, ako zistiť, koľko ľudí navštívilo vašu stránku GitHub Úložisko:

! [Hity] ( https://hitcounter.pythonanywhere.com/count/tag.svg? url = Paste_Your_GitHub_Repository_Link_Here)

Nevýhodou počítadla Zobrazenia profilu aj HITS je, že nezobrazujú počet zobrazení s jedinečnými ID. Zakaždým, keď načítate prehliadač / úložisko, počty sa zvyšujú. Obnovením stránky by sa dalo ľahko získať viac zobrazení.

Plná implementácia odznakov GitHub

Ako príklad som použil svoje úložisko GitHub. Na vygenerovanie odznakov sa odporúča pridať tieto kódy do určeného súboru README.md. Ak vo svojom úložisku GitHub nemáte súbor README.md, najlepšou voľbou je manuálne vytvorenie jedného.

# Top 5 odznakov, ktoré posunú vaše úložisko GitHub na vyššiu úroveň
## 1. Štatistiky GitHub
! [Štatistiky vášho úložiska] ( https://github-readme-stats.vercel.app/api? používateľské meno = Tanu-N-Prabhu & show_icons = true)
## 2. Najpoužívanejšie jazyky
! [Štatistiky vášho úložiska] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Tanu-N-Prabhu&theme=blue-green)
## 3. Odznak prispievateľov
! [Štatistiky vášho úložiska] ( https://contrib.rocks/image? repo = Tanu-N-Prabhu / Python)
## 4. Generátor náhodných vtipov
! [Vtipná karta] ( https://readme-jokes.vercel.app/api)
## 5. Počítadlo zobrazenia profilu
! [Počítadlo zobrazenia profilu] ( https://komarev.com/ghpvc/?username=Tanu-N-Prabhu)
### Počítadlo zobrazenia úložiska - HITS
! [Hity] ( https://hitcounter.pythonanywhere.com/count/tag.svg? url = https://github.com/Tanu-N-Prabhu/Python)

Vo vašom súbore README.md nie je potrebné spúšťať alebo spúšťať vyššie uvedený fragment kódu. V okamihu, keď uložíte súbor s príponou (.md), GitHub automaticky vykreslí výstup a zmeny by sa priamo prejavili vo vašom úložisku.

K dispozícii je viac odznakov GitHub

Teraz, keď viete, ako pridať odznaky GitHub do svojho úložiska, je to skvelá voľba pre vývojárov a jednotlivcov, ktorí môžu pomocou týchto odznakov zvýšiť čitateľnosť svojich úložísk. Nie je to také ťažké - všetko, čo musíte urobiť, je vložiť niekoľko riadkov kódu Markdown na vygenerovanie odznakov.

Čím viac odznakov do svojho úložiska umiestnite, tým viac pozornosti získate. Jeden znak bude schopný poskytovať užitočné informácie, pokiaľ ide o štatistiky, stav a metriky.

Email
Ako klonovať úložisko pomocou GitHub Desktop

Chcete sa oboznámiť so softvérom na GitHub? Tu je postup, ako sa dostať na východ pomocou zjednodušeného nástroja GitHub Desktop.

Súvisiace témy
  • Programovanie
  • Markdown
  • GitHub
O autorovi
Tanu Pradhu (1 publikovaných článkov)Viac od Tanu Pradhua

Prihlásiť sa ku odberu noviniek

Pripojte sa k nášmu bulletinu s technickými tipmi, recenziami, bezplatnými elektronickými knihami a exkluzívnymi ponukami!

Ešte jeden krok…!

V e-maile, ktorý sme vám práve poslali, potvrďte svoju e-mailovú adresu.

.