Github badges - odznáčky pro repozitář

Git, Tipy & triky

Malé interaktivní barevné odznáčky, které si vývojáři dávají do záhlaví README souboru pro svůj repozitář. Zvyšují totiž pravděpodobnost, že zrovna po jejich knihovně jiní vývojáři sáhnou.

Github badges - odznáčky pro repozitář

Malé barevné odznáčky jsou velmi populární a použity u většiny projektů či knihoven, protože sdělují jednotným a přehledným stylem informace, které se vývojářům hodí. Navíc mohou odkazovat na jiný web či stránku, kde jsou informace více podrobnější. Vznikly původně pro Github, ale dají se používat i na jiných platformách jako GitLab, Bitbucket či webových stránkách.

Repozitáře s odznáčky v README zaujmou více lidí než projekty bez nich.
Zdroj: https://dev.to/seniru/badges-for-your-projects-5f8o

Služeb, které tyto odznáčky dokáží generovat již je více. Nejznámější je ale Shields.io, která se původně jmenovala b.adge.me, a generovala pouze JPG či PNG obrázky. Dokonce existuje i specifikace jak by měly jednotlivé odznáčky vizuálně vypadat.

Nejčastější sdělované informace

Build status a code coverage patří mezi nejčastěji používané odznáčky. Obsahují totiž informace, jestli prochází testy a také kolik procent kódu je jimi pokryto. Další často zobrazovaný údaj je aktuální verze knihovny či požadována minimální verze programovacího jazyka.

Protože představivosti se meze nekladou, lze najít i odznáčky s aktuálním počtem stažení, kvalitou kódu, odkaz na peněžitou podporu nebo číslo bitcoinové peněženky, odkazů na sociální sítě a mnoho dalšího. A hlavně je možné si vytvořit odznáček i s vlastním textem, jako jsem například udělal s dosaženým levelem PHP Stanu na repozitáři k responzivnímu stránkování.

Built with love

Jak na to

Některé služby generují odznáčky přímo, například Travis CI. Každá lepší služba ale vystavuje API, přes které je možné tyto údaje získat. Na jejich základě pak funguje již zmíněný Shields.io, který navíc podporuje možnost přidat ikonku ze serveru SimpleIcons.org. Další službou je Badgen.net, která má také podporu pro vlastní ikonky. Přímo pro PHP existuje třeba služba poser.pugx.org.

Poslední služba je ForTheBadge.com, která ale generované odznáčky nemá ve stejném stylu jako všechny ostatní služby. Za to ale obsahuje několik vtipných kousků, jako ten oranžový výše. Pěkné shrnutí je také v tomto článku/repozitáři github.com/dwyl/repo-badges.


Používáte také odznáčky v repozitáři nebo znáte lepší služby? Podělte se v komentářích

Přidat komentář

Položky označené * jsou povinné. Email nebude zveřejněn

Buď první, kdo přidá komentář. Zatím zde nic není