RichardLitt/standard-readme

Improve documentation on using badges in README

Chiusa

#157 aperta il 7 nov 2025

Vedi su GitHub
 (3 commenti) (1 reazione) (0 assegnatari)Shell (2483 fork)batch import
enhancementhelp wanted

Metriche repository

Star
 (5239 stelle)
Metriche merge PR
 (Merge medio 2h 3m) (1 PR mergiata in 30 g)

Descrizione

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!

Guida contributor

Direzione di ricerca
Aggiungi una sottosezione con esempi Markdown di badge comuni (es. shields.io) e best practice per il posizionamento.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitHubMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90