Les badges GitHub peuvent améliorer la lisibilité d'un référentiel en fournissant aux utilisateurs un moyen rapide de capturer les métriques du référentiel. Des badges peuvent être intégrés dans votre README.md pour clarifier l'importance et la nécessité de votre projet aux autres développeurs. En conséquence, les lecteurs ont une idée très rapide du référentiel en vérifiant les badges attachés.
Il existe de nombreux badges GitHub disponibles sur Internet, voici les cinq badges les plus informatifs à inclure dans votre fichier README.md. Pour chaque badge répertorié, le code Markdown équivalent est fourni.
Que peuvent faire les badges GitHub pour vous?
Ajouter des badges GitHub à votre référentiel peut sembler trivial, mais en fait, c'est incroyablement utile. Tout ce que vous avez à faire est d'importer le code Markdown de la source vers votre fichier README.md.
Lorsque j'ai créé mon référentiel GitHub de programmation Python, j'ai omis les badges. Mon référentiel non embelli avait le bon contenu mais ne se démarquait pas. Pour cette raison, le référentiel a gagné très peu de trafic (visiteurs uniques).
En rapport: Comment créer un référentiel GitHub
Envie de partager vos projets de développement en ligne? Voici comment démarrer avec votre premier référentiel Github.
Après avoir ajouté plus de badges à mon référentiel, j'ai vu une augmentation automatique du nombre de visiteurs externes (de 5 à 767) par mois (voir vos visiteurs uniques en Insights> Trafic sur votre référentiel.)
Ma boîte de réception était remplie de commentaires sur la façon dont mon référentiel se démarquait des autres référentiels de programmation Python, tout cela à cause des badges. Un simple badge GitHub peut complètement changer l'apparence de votre référentiel.
Gardez toujours cela à l'esprit: un badge vaut 1000 lignes de code.
Le badge Statistiques GitHub montre le nombre total d'étoiles, de validations, de demandes d'extraction, de problèmes et de contributions de votre référentiel GitHub.
- Étoiles: Les utilisateurs enregistrent les référentiels GitHub (comme la création de signets). Cela indique que l'utilisateur est intéressé et souhaite rester à jour avec le référentiel enregistré. Cependant, un référentiel étoilé ne peut pas être modifié.
- S'engage: L'enregistrement d'une modification dans un référentiel est appelé validation. Divers détails sont ajoutés à un commit, contenu, message (description), nom de l'auteur et horodatage.
- Demande de tirage: Une demande d'extraction informe les autres des améliorations que vous avez apportées à un autre dépôt GitHub, à l'exception du vôtre. Nous appelons souvent Pull Request le cœur de la collaboration GitHub.
- Questions: Les problèmes GitHub sont utilisés pour obtenir les commentaires des utilisateurs, suivre les idées, les améliorations et répertorier les bogues signalés au référentiel.
- Contribution: Les contributions GitHub indiquent le nombre de contributions qui ont été apportées à d'autres référentiels. Une contribution peut être faite à l'aide d'une Pull Request.
Pour ajouter le badge GitHub Stats à votre référentiel, intégrez le code Markdown ci-dessous dans votre fichier README.md.
! [Statistiques de votre référentiel] ( https://github-readme-stats.vercel.app/api? username = Your_GitHub_Username & show_icons = true)Assurez-vous de changer le nom d'utilisateur = valeur au nom d'utilisateur de votre GitHub. Le badge GitHub Stats fournit également des classements ainsi que S + (top 1%), S (top 25%), A ++ (top 45%), A + (top 60%) et B + (tout le monde). Plus vos statistiques sont élevées, meilleur est votre classement.
Comme son nom l'indique, le badge Langues les plus utilisées affiche les langues les plus couramment utilisées dans GitHub. Il s'agit d'une métrique GitHub dont les langues telles que HTML, CSS, JavaScript, Python, Go, et d'autres ont le plus de code sur GitHub. Les langues sont répertoriées par ordre décroissant.
En rapport: Quel langage de programmation devriez-vous apprendre?
Pour ajouter le badge Langues les plus utilisées à votre référentiel, intégrez le Markdown ci-dessous à votre fichier README.md.
! [Statistiques de votre référentiel] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Your_GitHub_Username&theme=blue-green)Le seul inconvénient de ce badge est qu'il ne répertorie pas Markdown comme la langue la plus couramment utilisée.
Le badge des contributeurs affiche toutes les opérations telles que ajouts, suppressions, et s'engage qui ont été effectuées sur vos référentiels. Lorsque vous fusionnez une demande d'extraction dans votre référentiel, la personne qui a créé la demande sera ajoutée en tant que contributeur. C'est vraiment une bonne habitude de créditer les contributeurs qui ont investi leur temps à fournir une mise à jour de votre référentiel.
Le badge des contributeurs peut être généré à l'aide de contributors-img, une application Web qui génère une image pour afficher la liste des contributeurs.
Générer l'image du contributeur est assez simple. Accédez au site Web contributors-img et collez le nom de votre référentiel avec votre Nom d'utilisateur pour générer l'URL. Sinon, intégrez simplement le code Markdown ci-dessous pour obtenir l'image.
! [Image des contributeurs GitHub] ( https://contrib.rocks/image? repo = Your_GitHub_Username / Your_GitHub_Repository_Name)Le générateur de blagues aléatoires générera une blague technique sous forme de questions et réponses. Par exemple, "Qu'est-ce qu'un virus informatique? La maladie terminale”.
Pour utiliser le badge, vous devez intégrer le code Markdown dans votre fichier README.md comme indiqué ci-dessous.
## 😂 Voici une blague aléatoire qui vous fera rire!
! [Carte blagues] ( https://readme-jokes.vercel.app/api)Le badge Compteur de vues de profil affiche le nombre de fois où votre profil GitHub a été consulté dans votre profil. Pour générer ce badge, intégrez le code Markdown suivant:
! [Compteur de vues de profil] ( https://komarev.com/ghpvc/?username=Your_GitHub_Username)Pour générer le nombre de vues de votre référentiel, vous pouvez utiliser le HITS (Comment les idiots suivent le succès) badge. C'est un moyen simple de voir combien de personnes ont visité votre GitHub dépôt:
Mais l’inconvénient du compteur de vues de profil et de HITS est qu’ils n’afficheront pas le nombre de vues avec des identifiants uniques. Chaque fois que vous rechargez le navigateur / le référentiel, les décomptes sont incrémentés. On pourrait facilement obtenir plus de vues en actualisant la page.
Implémentation complète des badges GitHub
J'ai utilisé mon référentiel GitHub comme exemple. Pour générer les badges, il est recommandé d'ajouter ces codes à votre fichier README.md désigné. Si vous n'avez pas de fichier README.md dans votre référentiel GitHub, la meilleure option est d'en créer un manuellement.
# Top 5 des badges qui feront passer votre référentiel GitHub au niveau supérieur
## 1. Statistiques GitHub
! [Statistiques de votre référentiel] ( https://github-readme-stats.vercel.app/api? nom d'utilisateur = Tanu-N-Prabhu & show_icons = true)
## 2. Langues les plus utilisées
! [Statistiques de votre référentiel] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Tanu-N-Prabhu&theme=blue-green)
## 3. Badge des contributeurs
! [Statistiques de votre référentiel] ( https://contrib.rocks/image? repo = Tanu-N-Prabhu / Python)
## 4. Générateur de blague aléatoire
! [Carte blagues] ( https://readme-jokes.vercel.app/api)
## 5. Compteur de vues de profil
! [Compteur de vues de profil] ( https://komarev.com/ghpvc/?username=Tanu-N-Prabhu)
### Compteur de vues du référentiel - HITS
Il n'est pas nécessaire d'exécuter ou d'exécuter l'extrait de code de démarque ci-dessus sur votre fichier README.md. Au moment où vous enregistrez le fichier avec l'extension (.md), GitHub rendra automatiquement la sortie et les modifications seront directement reflétées sur votre référentiel.
Plus de badges GitHub disponibles
Maintenant que vous savez comment ajouter des badges GitHub à votre référentiel, c'est une excellente option pour les développeurs et les particuliers qui peuvent utiliser ces badges pour améliorer la lisibilité de leurs référentiels. Ce n’est pas si difficile: il vous suffit d’incorporer quelques lignes de code Markdown pour générer les badges.
Plus vous incluez de badges dans votre référentiel, plus vous obtiendrez d'attention. Un seul badge aura la capacité de fournir des informations utiles en termes de statistiques, de statut et de métriques.
Vous voulez vous familiariser avec les logiciels sur GitHub? Voici comment vous rendre à l'est avec l'outil simplifié de GitHub Desktop.
- Programmation
- Réduction
- GitHub
Abonnez-vous à notre newsletter
Rejoignez notre newsletter pour des conseils techniques, des critiques, des ebooks gratuits et des offres exclusives!
Un pas de plus…!
Veuillez confirmer votre adresse e-mail dans l'e-mail que nous venons de vous envoyer.
