A suggestion for us social GitHub'ers. There's almost always a README file, but what about a DEVME file where you give the gist (hah!) of how your app works from a developers perspective?

DEVME.md

HEADLINE

#Introduction The main ideas and philosophies behind how the project is constructed.

#Overview The main "components" of the project. What are the different responsibilites? Could be per-file if there aren't a lot of files. The aim is to help other developers navigate your code, but not be so deep that it quickly gets antiquated.

#Installation If there are any dependencies that needs to be installed to work with the project, or anything else needed to get up and running with developing a patch or fork.

#Requests This is a technical roadmap of things you would like to do but might not have time for. Things you know "smell bad" and would like to fix, if you have time. Basically what you wish people would do Pull Requests for.

idea.md

A suggestion for us social GitHub'ers. There's almost always a README file, but what about a DEVME file where you give the gist (hah!) of how your app works from a dev perspective? What are the interesting pieces? If I'm going to contribute, what would you like me to know? How to run Grunt or things like that often end up in the README but would be perfect in a DEVME instead.

I'd like to see README is what your users should know, and DEVME is what your social devs should know.

"But what about CONTRIBUTING?", you ask. Well, that file is usually much more like a how-to in forking, testing, and creating a pull request. DEVME is more for developers to share what's interesting with their solution (or things they're ashamed off?). It's a look inside the project itself, a commentary of sorts, that should help others faster get into the code but might yield feedback for the author on how to improve the project.