gruntjs / grunt-cli

Grunt's command line interface.
http://gruntjs.com/
MIT License
706 stars 248 forks source link

Add docs badge to README #69

Closed rrrene closed 9 years ago

rrrene commented 9 years ago

Hi there,

I want to propose to add this badge to the README to show off inline-documentation: Inline docs

The badge links to Inch CI and shows an evaluation by InchJS, a project that tries to raise the visibility of inline-docs (early adopters include forever, node-sass and when).

The idea is to motivate aspiring Node developers to dive into Open Source projects and read the code. It's about engagement, because, while testing and code coverage are important, inline-docs are the humanly engaging factor in Open Source. This project is about making people less adverse to jumping into the code and see whats happening, because they are not left alone while doing so. I know that, because I put off reading other people's code way too long in my life.

Although this is "only" a passion project, I really would like to hear your thoughts, critique and suggestions. Your status page is http://inch-ci.org/github/gruntjs/grunt-cli

What do you think?

vladikoff commented 9 years ago

It doesn't look like the score is correct in this case: image

rrrene commented 9 years ago

I see what you mean (or at least I can guess): an A is incorrect, because there is no mention of the return value?

sindresorhus commented 9 years ago

Doesn't really make sense to add it here as there are no useful comments in the code.