I badge GitHub possono aumentare la leggibilità di un repository fornendo agli utenti un modo rapido per acquisire le metriche del repository. I badge possono essere incorporati nel tuo README.md per chiarire l'importanza e la necessità del tuo progetto ad altri sviluppatori. Di conseguenza, i lettori hanno un'idea molto rapida del repository controllando i badge allegati.
Ci sono molti badge GitHub disponibili su Internet, ecco i primi cinque badge più informativi da includere nel file README.md. Per ogni badge elencato, viene fornito il codice Markdown equivalente.
Cosa possono fare i badge GitHub per te?
L'aggiunta di badge GitHub al tuo repository potrebbe sembrare banale, ma in realtà è incredibilmente utile. Tutto quello che devi fare è importare il codice Markdown dalla sorgente nel tuo file README.md.
Quando ho creato il mio repository GitHub di programmazione Python, ho omesso i badge. Il mio archivio senza ornamenti aveva i contenuti giusti ma non spiccava. Per questo motivo, il repository ha guadagnato pochissimo traffico (visitatori unici).
Relazionato: Come creare un repository GitHub
Vuoi condividere i tuoi progetti di sviluppo online? Ecco come iniziare con il tuo primo repository Github.
Dopo aver aggiunto altri badge al mio repository, ho visto un aumento automatico dei visitatori esterni (da 5 a 767) mensilmente (visualizza i tuoi visitatori unici in Approfondimenti> Traffico sul tuo repository.)
La mia casella di posta era piena di commenti su quanto il mio repository si distingueva dagli altri repository di programmazione Python, tutti a causa dei badge. Un semplice badge GitHub può cambiare completamente l'aspetto del tuo repository.
Tienilo sempre a mente: un badge vale 1000 righe di codice.
Il badge Statistiche GitHub mostra il totale di stelle, commit, richieste pull, problemi e contributi del tuo repository GitHub.
- Stelle: Gli utenti salvano i repository GitHub (come i segnalibri). Ciò indica che l'utente è interessato e desidera rimanere aggiornato con il repository salvato. Tuttavia, un repository contrassegnato da Speciali non può essere modificato.
- Si impegna: Il salvataggio di una modifica in un repository viene denominato commit. Vari dettagli vengono aggiunti a un commit, contenuto, messaggio (descrizione), nome dell'autore e timestamp.
- Richiesta pull: Una richiesta pull informa gli altri sui miglioramenti che hai trasferito a un repository GitHub diverso, tranne il tuo. Spesso ci riferiamo a Pull Request come al cuore della collaborazione GitHub.
- Problemi: I problemi di GitHub vengono utilizzati per ottenere feedback dagli utenti, tenere traccia di idee, miglioramenti ed elencare i bug segnalati al repository.
- Contributo: I contributi GitHub indicano il numero di contributi che sono stati effettuati ad altri repository. È possibile fornire un contributo con l'aiuto di una richiesta pull.
Per aggiungere il badge GitHub Stats al tuo repository, incorpora il codice Markdown riportato di seguito nel tuo file README.md.
! [Statistiche del tuo repository] ( https://github-readme-stats.vercel.app/api? username = Your_GitHub_Username & show_icons = true)Assicurati di cambiare il file nome utente = valore al nome utente di GitHub. Il badge Statistiche di GitHub fornisce anche gradi come S + (primo 1%), S (primo 25%), A ++ (primo 45%), A + (primo 60%) e B + (tutti). Più alte sono le tue statistiche, migliore è il tuo posizionamento.
Come suggerisce il nome, il badge Lingue più utilizzate mostra le lingue più comuni utilizzate in GitHub. È una metrica GitHub di cui linguaggi come HTML, CSS, JavaScript, Python, Go, e altri hanno la maggior parte del codice su GitHub. Le lingue sono elencate in ordine decrescente.
Relazionato: Quale linguaggio di programmazione dovresti imparare?
Per aggiungere il badge delle lingue più utilizzate al tuo repository, incorpora il Markdown di seguito nel tuo file README.md.
! [Statistiche del tuo repository] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Your_GitHub_Username&theme=blue-green)L'unico inconveniente di questo badge è che non elenca Markdown come la lingua più comunemente utilizzata.
Il badge dei contributori mostra tutte le operazioni come aggiunte, eliminazioni, e si impegna che sono stati eseguiti sui tuoi repository. Quando unisci una richiesta pull nel tuo repository, la persona che ha creato la richiesta verrà aggiunta come collaboratore. È davvero una buona abitudine dare credito ai contributori che hanno investito il loro tempo nel fornire un aggiornamento al tuo repository.
Il badge dei contributori può essere generato utilizzando contributors-img, un'applicazione web che genera un'immagine per visualizzare l'elenco dei contributori.
Generare l'immagine del contributore è piuttosto banale. Vai al sito web contributors-img e incolla il file nome del tuo repository insieme al tuo nome utente per generare l'URL. In alternativa, incorpora semplicemente il codice Markdown indicato di seguito per ottenere l'immagine.
! [Immagine dei collaboratori di GitHub] ( https://contrib.rocks/image? repo = Your_GitHub_Username / Your_GitHub_Repository_Name)Il generatore di scherzi casuali genererà uno scherzo tecnico sotto forma di domande e risposte. Per esempio, "Cos'è un virus informatico? La malattia terminale”.
Per utilizzare il badge è necessario incorporare il codice Markdown nel file README.md come mostrato di seguito.
## 😂 Ecco uno scherzo casuale che ti farà ridere!
! [Scheda scherzi] ( https://readme-jokes.vercel.app/api)Il badge Contatore visualizzazione profilo mostra il numero di volte in cui il tuo profilo GitHub è stato visualizzato nel tuo profilo. Per generare questo badge, incorpora il seguente codice Markdown:
! [Contatore visualizzazione profilo] ( https://komarev.com/ghpvc/?username=Your_GitHub_Username)Per generare il conteggio delle visualizzazioni del tuo repository, potresti voler utilizzare HITS (Come gli idioti monitorano il successo) badge. È un modo semplice per vedere quante persone hanno visitato il tuo GitHub repository:
Ma lo svantaggio sia del contatore Visualizzazione profilo che di HITS è che non visualizzano il conteggio delle visualizzazioni con ID univoci. Ogni volta che ricarichi il browser / repository, i conteggi verranno incrementati. Si potrebbero facilmente ottenere più visualizzazioni aggiornando la pagina.
Implementazione completa dei badge GitHub
Ho usato il mio repository GitHub come esempio. Per generare i badge, si consiglia di aggiungere questi codici al file README.md designato. Se non hai un file README.md nel tuo repository GitHub, crearne uno manualmente è l'opzione migliore.
# I 5 migliori badge che porteranno il tuo repository GitHub al livello successivo
## 1. Statistiche GitHub
! [Statistiche del tuo repository] ( https://github-readme-stats.vercel.app/api? username = Tanu-N-Prabhu & show_icons = true)
## 2. Lingue più utilizzate
! [Statistiche del tuo repository] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Tanu-N-Prabhu&theme=blue-green)
## 3. Badge dei contributori
! [Statistiche del tuo repository] ( https://contrib.rocks/image? repo = Tanu-N-Prabhu / Python)
## 4. Generatore di scherzi casuali
! [Scheda scherzi] ( https://readme-jokes.vercel.app/api)
## 5. Contatore vista profilo
! [Contatore visualizzazione profilo] ( https://komarev.com/ghpvc/?username=Tanu-N-Prabhu)
### Contatore visualizzazione repository - HITS
Non è necessario eseguire o eseguire lo snippet di codice markdown sopra riportato sul file README.md. Nel momento in cui salvi il file con estensione (.md), GitHub renderà automaticamente l'output e le modifiche si rifletteranno direttamente sul tuo repository.
Altri badge GitHub disponibili
Ora che sai come aggiungere badge GitHub al tuo repository, è un'ottima opzione per sviluppatori e individui che possono utilizzare questi badge per aumentare la leggibilità dei loro repository. Non è così difficile: tutto ciò che devi fare è incorporare poche righe di codice Markdown per generare i badge.
Più badge includi nel tuo repository, maggiore sarà l'attenzione che riceverai. Un singolo badge avrà la capacità di fornire informazioni utili in termini di statistiche, stato e metriche.
Vuoi fare i conti con il software su GitHub? Ecco come farlo est con lo strumento GitHub Desktop ottimizzato.
- Programmazione
- Markdown
- GitHub
Iscriviti alla nostra Newsletter
Iscriviti alla nostra newsletter per suggerimenti tecnici, recensioni, ebook gratuiti e offerte esclusive!
Ancora un passo…!
Conferma il tuo indirizzo e-mail nell'e-mail che ti abbiamo appena inviato.