GitHub Badges poate spori lizibilitatea unui depozit oferind utilizatorilor o modalitate rapidă de a capta valorile depozitului. Insigne pot fi încorporate în README.md pentru a clarifica importanța și necesitatea proiectului dvs. pentru alți dezvoltatori. Drept urmare, cititorii își fac o idee foarte rapidă despre depozit verificând insignele atașate.
Există multe ecusoane GitHub disponibile pe internet, aici sunt primele cinci ecusoane cele mai informative de inclus în fișierul README.md. Pentru fiecare insignă listată, este furnizat codul echivalent Markdown.
Ce pot face insignele GitHub pentru dvs.?
Adăugarea insignelor GitHub în depozitul dvs. ar putea părea banală, dar de fapt este incredibil de utilă. Tot ce trebuie să faceți este să importați codul Markdown din sursă în fișierul README.md.
Când am creat depozitul GitHub de programare Python, am omis insignele. Depozitul meu neînfrumusețat avea conținutul potrivit, dar nu se remarca. Din această cauză, depozitul a câștigat foarte puțin trafic (vizitatori unici).
Legate de: Cum se creează un depozit GitHub
Doriți să partajați proiectele dvs. de dezvoltare online? Iată cum să începeți cu primul dvs. depozit Github.
După ce am adăugat mai multe ecusoane la depozitul meu, am văzut o creștere automată a vizitatorilor externi (de la 5 la 767) lunar (vizualizați-vă vizitatorii unici în Statistici> Trafic în depozitul dvs.)
Inbox-ul meu a fost plin de comentarii despre cât de bine s-a remarcat depozitul meu de alte depozite de programare Python, toate din cauza insignelor. O insignă GitHub simplă poate schimba complet aspectul depozitului dvs.
Rețineți întotdeauna acest lucru: o insignă merită 1000 de linii de cod.
Insigna GitHub Stats demonstrează numărul total de stele, angajamente, cereri de extragere, probleme și contribuții din depozitul dvs. GitHub.
- Stele: Utilizatorii salvează depozitele GitHub (cum ar fi marcarea). Aceasta indică faptul că utilizatorul este interesat și dorește să fie la curent cu depozitul salvat. Cu toate acestea, un depozit cu stele nu poate fi editat.
- Angajamente: Salvarea unei modificări într-un depozit este denumită comitere. Diverse detalii sunt anexate la un commit, conținut, mesaj (descriere), numele autorului și marca de timp.
- Trageți cererea: O cerere Pull îi informează pe ceilalți despre îmbunătățirile pe care le-ați introdus într-un alt depozit GitHub, cu excepția dvs. De multe ori ne referim la Pull Request ca fiind inima colaborării GitHub.
- Probleme: Problemele GitHub sunt utilizate pentru a obține feedback-ul utilizatorilor, pentru a urmări ideile, îmbunătățirile și pentru a lista erorile raportate la depozit.
- Contribuţie: Contribuțiile GitHub indică numărul de contribuții care au fost făcute altor depozite. O contribuție poate fi făcută cu ajutorul unei cereri de extragere.
Pentru a adăuga insigna GitHub Stats în depozitul dvs., încorporați codul Markdown de mai jos în fișierul README.md.
! [Statisticile depozitului dvs.] ( https://github-readme-stats.vercel.app/api? username = Your_GitHub_Username & show_icons = true)
Asigurați-vă că schimbați nume de utilizator = valoare pentru numele de utilizator GitHub. Insigna GitHub Stats oferă, de asemenea, ranguri, cum ar fi S + (top 1%), S (top 25%), A ++ (top 45%), A + (top 60%) și B + (toată lumea). Cu cât statisticile sunt mai ridicate, cu atât este mai bună clasarea.
După cum sugerează și numele, insigna Cele mai utilizate limbi afișează cele mai frecvente limbi utilizate în GitHub. Este o metrică GitHub din care limbi precum HTML, CSS, JavaScript, Python, Go, și multe altele au cel mai mult cod pe GitHub. Limbile sunt listate în ordine descrescătoare.
Legate de: Ce limbaj de programare ar trebui să înveți?
Pentru a adăuga insigna Cele mai utilizate limbi în depozitul dvs., încorporați Markdown-ul de mai jos în fișierul README.md.
! [Statisticile depozitului dvs.] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Your_GitHub_Username&theme=blue-green)
Singurul dezavantaj al acestei insigne este că nu va afișa Markdown ca limbă cea mai frecvent utilizată.
Insigna Contributorilor afișează toate operațiunile, cum ar fi completări, ștergeri, și comite care au fost efectuate în depozitele dvs. Când îmbinați o cerere de extragere în depozitul dvs., persoana care a creat solicitarea va fi adăugată ca colaborator. Este cu adevărat un obicei bun să creditați contribuitorii care și-au investit timpul în furnizarea unei actualizări depozitului dvs.
Insigna Contributors poate fi generată folosind contributors-img, o aplicație web care generează o imagine pentru a afișa lista contribuitorilor.
Generarea imaginii contribuitorului este destul de banală. Navigați la site-ul contributors-img și lipiți numele depozitului dvs. împreună cu dumneavoastră nume de utilizator pentru a genera adresa URL. Alternativ, pur și simplu încorporați codul Markdown dat mai jos pentru a obține imaginea.
! [Imagine colaboratori GitHub] ( https://contrib.rocks/image? repo = Your_GitHub_Username / Your_GitHub_Repository_Name)
Generatorul de glume aleatorii va genera o glumă tehnică sub formă de întrebări și răspunsuri. De exemplu, "Ce este un virus computerizat? Boala terminală”.
Pentru a utiliza insigna, trebuie să încorporați codul Markdown în fișierul README.md, așa cum se arată mai jos.
## 😂 Iată o glumă aleatorie care te va face să râzi!
! [Card glume] ( https://readme-jokes.vercel.app/api)
Insigna Contor Vizualizare profil afișează de câte ori a fost vizualizat profilul dvs. GitHub în profilul dvs. Pentru a genera această insignă, încorporați următorul cod Markdown:
! [Contor Vizualizare profil] ( https://komarev.com/ghpvc/?username=Your_GitHub_Username)
Pentru a genera numărul de vizualizări al depozitului dvs., vă recomandăm să utilizați HITS (Cum idioții urmăresc succesul) insignă. Este un mod simplu de a vedea câți oameni v-au vizitat GitHub repertoriu:
! [Hits] ( https://hitcounter.pythonanywhere.com/count/tag.svg? url = Paste_Your_GitHub_Repository_Link_Here)
Dar dezavantajul atât al contorului Vizualizare profil, cât și al HITS este că acestea nu afișează numărul de vizualizări cu ID-uri unice. De fiecare dată când reîncărcați browserul / depozitul, numărul va fi incrementat. S-ar putea obține cu ușurință mai multe vizualizări prin reîmprospătarea paginii.
Implementarea completă a insignelor GitHub
Am folosit ca exemplu depozitul meu GitHub. Pentru a genera ecusoane, este recomandat să adăugați aceste coduri în fișierul README.md desemnat. Dacă nu aveți un fișier README.md în depozitul GitHub, atunci creați manual unul este cea mai bună opțiune.
# Top 5 ecusoane care vor duce depozitul dvs. GitHub la nivelul următor
## 1. Statistici GitHub
! [Statisticile depozitului dvs.] ( https://github-readme-stats.vercel.app/api? nume utilizator = Tanu-N-Prabhu & show_icons = adevărat)
## 2. Cele mai utilizate limbi
! [Statisticile depozitului dvs.] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Tanu-N-Prabhu&theme=blue-green)
## 3. Insignă pentru colaboratori
! [Statisticile depozitului dvs.] ( https://contrib.rocks/image? repo = Tanu-N-Prabhu / Python)
## 4. Generator de glume aleatorii
! [Card glume] ( https://readme-jokes.vercel.app/api)
## 5. Contor Vizualizare profil
! [Contor Vizualizare profil] ( https://komarev.com/ghpvc/?username=Tanu-N-Prabhu)
### Contor vizualizare depozit - HITS
! [Hits] ( https://hitcounter.pythonanywhere.com/count/tag.svg? url = https://github.com/Tanu-N-Prabhu/Python)
Nu este nevoie să executați sau să rulați fragmentul de cod de marcare de mai sus în fișierul README.md. În momentul în care salvați fișierul cu extensia (.md), GitHub va reda automat ieșirea și modificările se vor reflecta direct în depozitul dvs.
Mai multe ecusoane GitHub disponibile
Acum, că știți cum să adăugați insignele GitHub în depozitul dvs., este o opțiune excelentă pentru dezvoltatori și persoane care pot utiliza aceste insigne pentru a spori lizibilitatea depozitelor lor. Nu este atât de dificil - tot ce trebuie să faceți este să încorporați câteva linii de cod Markdown pentru a genera ecusoane.
Cu cât includeți mai multe ecusoane în depozit, cu atât veți primi mai multă atenție. O singură insignă va avea capacitatea de a furniza informații utile în ceea ce privește statisticile, starea și valorile.
Doriți să faceți cunoștință cu software-ul de pe GitHub? Iată cum puteți ajunge la est cu instrumentul GitHub Desktop simplificat.
- Programare
- Markdown
- GitHub
Aboneaza-te la newsletter-ul nostru
Alăturați-vă newsletter-ului pentru sfaturi tehnice, recenzii, cărți electronice gratuite și oferte exclusive!
Încă un pas…!
Vă rugăm să confirmați adresa de e-mail în e-mailul pe care tocmai vi l-am trimis.