Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs badge to README #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

rrrene
Copy link

@rrrene rrrene commented Feb 6, 2015

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
Copy link
Owner

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
Copy link
Author

rrrene commented Feb 9, 2015

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
Copy link
Collaborator

artokun commented Jun 15, 2017

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants