Topics

The welcome mat is out!


David A. Wheeler
 

There have been a number of code-level changes recently, including ones that I hope will make it easier for others to get involved.

 

I documented in doc/INSTALL.md the steps to install a development environment.  I then realized that there are a lot of little annoying steps, so I also wrote a shell script that tries to install it automatically.

 

It’d be great if other people could try out the doc/INSTALL.md instructions (including the script), and tell me what went wrong in their environment so we can fix it.  If someone can fire up some VMs with various operating systems that’d be awesome.  Ruby’s bundler handles a lot of library installs automagically, but you do have to go through various steps to get there.

 

Dan Kohn and I have been adding various analysis tools and tests to the default “rake” command, and we have more tests too.  This should make it way easier for people to join – they’ll start with an environment that helps them identify the project conventions and common mistakes.

 

Since OSS projects are all about collaboration, I think it’s vitally important to make it *easy* for people to join.  So I hope these actions help make it *easy* for others to join.  I’m working on how to install a development environment early before I forget many of the steps myself. We all want to get the analysis tools and test framework set up now, so that we can fix problems *now* instead of letting them grow.  Besides, it’d be embarrassing for the project to fail its own criteria… so let’s avoid that :-).

 

--- David A. Wheeler