RichardLitt/standard-readme

Improve documentation on using badges in README

Fechada

#157 aberto em 7 de nov. de 2025

Ver no GitHub
 (3 comentários) (1 reação) (0 responsável)Shell (2.483 forks)batch import
enhancementhelp wanted

Métricas do repositório

Stars
 (5.239 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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!

Guia do colaborador

Direção de pesquisa
Adicione uma subseção com exemplos Markdown de badges comuns (ex: shields.io) e melhores práticas de posicionamento.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitHubMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90