Is it fine to add codebeat badge to README?
codebeat is automated code review tool for Swift,Ruby,Go & Python that helps get instant feedback on code quality.
"Quick wins" suggested by codebeat could be a nice candidate for a pull request and help other developers become contributors.
FYI. To be fully open and honest. I'm co-founder of codebeat.
The coverage button currently shows 56% coverage for our Go code in a red color.
Unfortunately, this is incorrect because coverage is only tested and
added up for code within the same package. However, our true
coverage is much higher because we have dedicated integration test
packages which cover a lot of other packages.
Therefore, we'll remove the coverage button for now. Once we fixed
calculating the true coverage, we can re-add it.
Add travis configuration and dependencies script
Split integration test make targets to allow parallel execution in Travis
Add go packages required for coverage upload to Coveralls
Add coveralls and travis badges to README
Travis: Retry make targets to address flaky targets
The prevailing convention on GitHub seems to be .md
Also by moving CONTRIBUTING.md to the root, GitHub will automatically
link to it when someone tries to contribute:
https://github.com/blog/1184-contributing-guidelines