Add unit test and code coverage badges to README

commonsearch / cosr-back

Backend of Common Search. Analyses webpages and sends them to the index.

https://about.commonsearch.org

Apache License 2.0

122 stars 24 forks source link

Add unit test and code coverage badges to README #32

Closed hjacobs closed 8 years ago

hjacobs commented 8 years ago

Rather easy to do and helps seeing the project "health" immediately:

add build status badge (https://travis-ci.org/commonsearch/cosr-back)
add code coverage badge (using a service such as coveralls or codecov)
maybe add license badge too

IMHO a lot of people (including myself) look for these badges (e.g. to get a first impression on test quality).

Example project with (IMHO relevant) badges: https://github.com/zalando/connexion

sylvinus commented 8 years ago

Thanks @hjacobs for the suggestion!

I originally thought about it but felt it was somewhat annoying to have third-party images on the READMEs. However after looking deeper into it, it looks like GitHub actually proxies them, which makes it okay :)

Adding code coverage is also a great idea. I will give coveralls a try!

sylvinus commented 8 years ago

Coverage is working :) Thanks!