RichardLitt/standard-readme

Improve documentation on using badges in README

Open

#157 ouverte le 7 nov. 2025

Voir sur GitHub
 (3 commentaires) (1 réaction) (0 assignés)Shell (5 239 stars) (2 483 forks)batch import
enhancementhelp wanted

Description

I was going through the README and noticed that the “Badges” section is mentioned, but I found it a bit unclear on how to actually use them.

It would be super helpful if the docs could explain:

  • Which badge services are commonly used
  • Examples of badges with Markdown syntax
  • Any guidelines for placement or sizing

Right now, the section just briefly mentions badges without showing how to add them, so newcomers might be a bit lost.

It’d be great if a small subsection could be added with example code snippets and some best practices for including badges in a README. Thanks!

Guide contributeur

Stack technique
Aucun
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
MarkdownREADME structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
Examine the current README at https://github.com/RichardLitt/standard readme/blob/master/README.md, specifically the 'Badges' section. Review common badge services like Shields.io and their Markdown syntax. Look at the comments in issue #157 for any additional suggestions. Provide example code snippets and guidelines for badge placement and sizing.