Les badges GitHub peuvent améliorer la lisibilité d'un référentiel en offrant 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 se font une idée très rapide du référentiel en vérifiant les badges joints.
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 ?
L'ajout de 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 dans votre fichier README.md.
Lorsque j'ai créé mon référentiel Python Programming GitHub, j'ai omis les badges. Mon référentiel non embelli avait le bon contenu mais ne se démarquait pas. De ce fait, le référentiel a gagné très peu de trafic (visiteurs uniques).
Connexes : Comment créer un référentiel GitHub
Après avoir ajouté plus de badges à mon référentiel, j'ai constaté une augmentation automatique du nombre de visiteurs externes (de 5 à 767) par mois (consultez vos visiteurs uniques dans 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 GitHub Stats montre le nombre total d'étoiles, de commits, de demandes d'extraction, de problèmes et de contributions de votre référentiel GitHub.
- Stars : les utilisateurs enregistrent les référentiels GitHub (comme la mise en signet). 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é.
- Commits : l'enregistrement d'une modification dans un référentiel est appelé un commit. Divers détails sont ajoutés à un commit, un contenu, un message (description), le nom de l'auteur et l'horodatage .
- Pull Request : une Pull Request informe les autres des améliorations que vous avez poussées vers un autre référentiel GitHub, à l'exception du vôtre. Nous nous référons souvent à la demande de tirage comme au cœur de la collaboration GitHub.
- Problèmes : 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 : GitHub Contributions indique le nombre de contributions qui ont été apportées à d'autres référentiels. Une contribution peut être faite à l'aide d'un Pull Request.
Pour ajouter le badge GitHub Stats à votre référentiel, intégrez le code Markdown ci-dessous dans votre fichier README.md.
![Your Repository's Stats](https://github-readme-stats.vercel.app/api?username=Your_GitHub_Username&show_icons=true)
Assurez-vous de remplacer la valeur username= par le nom d'utilisateur de votre GitHub. Le badge GitHub Stats fournit également des classements tels 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 langages tels que HTML, CSS, JavaScript, Python, Go, etc. ont le plus de code sur GitHub. Les langues sont répertoriées par ordre décroissant.
Connexe : 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 dans votre fichier README.md.
![Your Repository's Stats](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 langage le plus couramment utilisé.
Le badge des contributeurs affiche toutes les opérations telles que les ajouts , les suppressions et les commits 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 remercier les contributeurs qui ont investi leur temps pour fournir une mise à jour de votre référentiel.
Le badge des contributeurs peut être généré à l'aide de contributeurs-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 trivial. Accédez au site Web de contributeurs-img et collez le nom de votre référentiel avec votre nom d' utilisateur pour générer l'URL. Alternativement, intégrez simplement le code Markdown ci-dessous pour obtenir l'image.
![GitHub Contributors Image](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.
## 😂 Here is a random joke that'll make you laugh! ![Jokes Card](https://readme-jokes.vercel.app/api)
Le badge Compteur de vues de profil affiche le nombre de fois que votre profil GitHub a été consulté dans votre profil. Pour générer ce badge, intégrez le code Markdown suivant :
![Profile View Counter](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 badge HITS ( How Idiots Track Success ). C'est un moyen simple de voir combien de personnes ont visité votre référentiel GitHub :
![Hits](https://hitcounter.pythonanywhere.com/count/tag.svg?url = Paste_Your_GitHub_Repository_Link_Here)
Mais l'inconvénient du compteur de vues de profil et de HITS est qu'ils n'affichent pas le nombre de vues avec des identifiants uniques. Chaque fois que vous rechargez le navigateur/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, en créer un manuellement est la meilleure option.
# Top 5 Badges That Will Take Your GitHub Repository to the Next Level ## 1. GitHub Stats ![Your Repository's Stats](https://github-readme-stats.vercel.app/api?username=Tanu-N-Prabhu&show_icons=true) ## 2. Most Used Languages ![Your Repository's Stats](https://github-readme-stats.vercel.app/api/top-langs/?username=Tanu-N-Prabhu&theme=blue-green) ## 3. Contributors Badge ![Your Repository's Stats](https://contrib.rocks/image?repo=Tanu-N-Prabhu/Python) ## 4. Random Joke Generator ![Jokes Card](https://readme-jokes.vercel.app/api) ## 5. Profile View Counter ![Profile View Counter](https://komarev.com/ghpvc/?username=Tanu-N-Prabhu) ### Repository View Counter - HITS ![Hits](https://hitcounter.pythonanywhere.com/count/tag.svg?url=https://github.com/Tanu-N-Prabhu/Python)
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 seraient directement répercuté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 augmenter la lisibilité de leurs référentiels. Ce n'est pas si difficile - tout ce que vous avez à faire est d'intégrer quelques lignes de code Markdown pour générer les badges.
Plus vous incluez de badges dans votre référentiel, plus vous attirerez d'attention. Un seul badge aura la capacité de fournir des informations utiles en termes de statistiques, de statut et de métriques.