search

nathanpeck / clui

Command Line UI toolkit for Node.js
MIT License
1.66k stars 40 forks source link

Add docs badge to README #3

Open rrrene opened 9 years ago

rrrene commented 9 years ago

Hi Nathan,

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

I do get that you are not big on badges in your README, but bear with me:

The badge links to Inch CI and shows an evaluation by InchJS, a project that tries to raise the visibility of inline-docs. This little project of mine is about engagement. And for me, 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 seeing 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.

I would really like to roll out support for JS over the coming weeks (early adopters are forever, node-sass and Shipit). And 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/nathanpeck/clui

While a polite "No thank you" is absolutely okay, I am curious: What do you think about this?

nathanpeck commented 9 years ago

Thanks for the suggestion. I made a cursory look at InchCI and it looks pretty cool. I'll see about adding better inline documentation on this and other packages I have and add the docs badge at some point.

rrrene commented 9 years ago

Thanks for considering!

One last note: Please understand that this badge is not about showing off how good your documentation is, but to engage aspiring Node developers to dive into Open Source projects and read the code. This badge tries to highlight that anybody who wants to read your source code and/or contribute can except some inline-docs to be present.

The motivation behind this is simple: Reading other people's code is something I personally put off way too long in my development career and I have become a much better programmer since I do. The badge tries to convey this humanly engaging aspect of Open Source development.

artokun commented 7 years ago

This looks interesting. Once I wrap things up here I will go through and add inline comments