RichardLitt/standard-readme

Improve documentation on using badges in README

Closed

#157 opened on Nov 7, 2025

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Shell (2,483 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,239 stars)
PR merge metrics
 (Avg merge 2h 3m) (1 merged PR in 30d)

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!

Contributor guide

Research direction
Add a subsection with markdown examples of common badges (e.g., shields.io) and best practices for placement.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitHubMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90