Github

Badges

Why?

• Showing off
• Continuous integration
• Help collaborators follow standards
• Help users find your code details

Must have badges

Build Badge

AKA - ci badge

Comes from any continuous integration tool, most popular one is travis-ci (because its free). travis-ci.org

Shows your last commit builds successfully (or not), so users can rest assured that at least your library is doing what you expect it to do.

Coverage Badge

untested code is deprecated code

Comes from any coverage as a service tool, most popular one is coveralls and goes hand by hand with the ci-badge

Can be your best friend or your worst enemy. Either way it will help you to improve your code!

Package Badge

if your code isn't in a registry, how are you distributing it? 🤔

Package badges support any kind of pm, from pypi, gem, npm to homebrew.

Getting the badge depends on the package manager you are using but there are a few sites which help out with that.

Dependecies Badge

check those dependencies!

Your dependencies can be out of date or insecure, instead of making your users go through your entire dependencies, just add a badge and save them some time!

For node base projects, david is the de-facto badge provider.

For other languages.. ¯\(ツ)/¯ 

Code Style Badge

One style to rule your code!

Show your contributors what code style you are using, that will make sure you are all on the same page. When the linter runs, devs will know why it fails and where to look for the linter docs.

Its a tricky one, no ci features so its just informative not a reflection of your code.

One Million badges!

The amount of badges available is overwhelming at best, luckily there are sites like shields.io that provides all the badges you need!

Add those badges to your repo, get the stars! 👉😉👉