"Audited with ci-doctor" README badge
A small badge for your README that signals your repo's GitHub Actions workflows pass ci-doctor's 14 cost and reliability rules. Free, static, hosted on shields.io. Click it: it links to /rules.html on this site.
Quick: just give me the snippet
Drop this at the top of your README. Works in any Markdown renderer:
[](https://depmedicdev-byte.github.io/rules.html)
Customize
flat
flat-square
for-the-badge
plastic
Preview
Markdown (paste into README.md)
HTML (paste into a doc site)
Why use this
Three small upsides:
- Anyone landing on your README sees you take CI hygiene seriously - no extra config.
- Clicking the badge opens the 14-rule reference, so contributors who've never used ci-doctor learn what you're enforcing.
- It's static. No status check. No build pipeline impact. The shields.io URL is cached aggressively.
If you'd like the badge to actually verify ci-doctor passed in your CI, run ci-doctor in a workflow with --fail-on error and use a normal GitHub Actions status badge - documented in the official docs. The badge here is voluntary self-declaration.
Examples
flat - green
for-the-badge - blue
flat-square - black
