DEV Community

Helad
Helad

Posted on

What are you go to badges on your GitHub readme file?

Top comments (2)

Collapse
 
dmfay profile image
Dian Fay

Build status and test coverage % almost always; @jcowie mentioned a code quality metric but I think reducing so many factors into a single number loses most of the helpful information. Minimum Node engine version if appropriate, and download stats if it's got any traction.

Collapse
 
evanplaice profile image
Evan Plaice • Edited

Git Release
To ensure the latest release tag matches the latest release published to NPM. Also, it'll be behind if I forgot to fill out the release notes.

NPM Release
To ensure the published version is up-to-date and provide a link to the package on NPM.

License
My packages appear on multiple platforms. It's good to have the license visible on the README.md

Lastest Status
GitHub Actions status for the master branch. Good to see if the checks (lint, test, types) are failing.

Release Status
GitHub Actions status for the last published release. Everything undergoes extensive checks prior to release so this should never fail. But it's always good to have visibility on the status in case it does.