search

yeahrb / yeah

Ruby video game framework
MIT License
464 stars 26 forks source link

Add docs badge to README #22

Closed rrrene closed 10 years ago

rrrene commented 10 years ago

Hi there,

this patch adds a docs badge to the README to show off inline-documentation to potential contributors: Inline docs

The badge links to Inch CI, a project that tries to raise the visibility of inline-docs to encourage aspiring Rubyists to document their code. I recognize that you are not big on badges, but this could really inspire people à la "Look, this game engine has good inline-docs. Your open source game/project should too."

What do you think?

aostrega commented 10 years ago

Hi rrrene,

I took a look at Inch CI - it looks like a useful tool for developers to audit their code's documentation.

Currently, I am not up for adding badges or graphics that are not game screenshots to the README. Also, I believe that judging documentation quality is inherently fuzzy/arbitrary/human. While I would ask a robot for a second opinion on the quality of my documentation, I would not trust it to provide the official word on it.

Thanks for the suggestion!