Hot on the heels of my git setup script, user Sirupsen has made a
Starting with Git guide. Okay, that’s a lie, he actually published his guide two days before my script… I’m a slacker, I know, I apologize.

At any rate, thanks for the great guide Sirupsen!

The very first time we saw GitHub demonstrated, it was clear to us that it was important to the Ruby on Rails community, and something that we wanted to be associated with. In fact, we felt so strongly that we immediately offered Tom, Chris and P.J. free deployment on Engine Yard in exchange for free accounts for our customers and developers.

Why did we feel so strongly? I’d like to explain this on the record as many of our customers will no doubt wonder “Wow, that was a pretty good deal?” :-)

I was surprised when I didn’t find a Ruby gem that would analyze your code and give you a metric for how thorough your Rdoc documentation was. Since I want to keep myself accountable to keeping code documented, I whipped up the rdoc_metric gem. So far it is very simple, giving you percentages of how many of your class, module, method, attribute and constant declarations are documented using Rdoc.

Usage is simple, just cd into your application directory and use the rdoc_metric command: