Codebrawl, a code contest website focussed on the Ruby programming language and open source software.
Getting the project to run on your machine
First, check out the project:
git clone git://github.com/codebrawl/codebrawl.git && cd codebrawl
cd-ing into the project directory, you'll get an RVM notice telling you to read the
.rvmc. There's nothing scary in there (it switches to a Codebrawl specific gemset on Ruby 1.9.2), but be sure to always read this file when prompted to. Press enter to see the file, then type "yes" to switch to the gemset.
Install Bundler in your new gemset and use it to install Codebrawl's dependencies:
gem install bundler && bundle install
Copy the example config file:
cp config/codebrawl.example.yml config/codebrawl.yml
Now, run the tests and make sure they all pass:
bundle exec rspec spec
If you get a spec failure, please create an issue explaining what went wrong.
Want to help out, but have no idea where to get started? Here's a list of things you can do:
- Check out the tracker, choose an (unassigned) story, join the project and assign it to yourself
- Check out the open issues
- Hop into
#codebrawlon Freenode and ask
- Find a
TODOin the source, so you can help clean up a bit
- Refactor existing code
Fork the project, add your changes (with specs), and send a pull request. Thanks for helping out! :)