A Ruby programming competition community focussed on creating and improving great open source software.
Getting the project to run on your machine
We're trying to make it as easy as possible to get Codebrawl running on your machine. If you run into any problems getting it to run or know an easier way, be sure to create an issue.
First, clone the project:
git clone git://github.com/codebrawl/codebrawl.git && cd codebrawl
Use Bundler to install the dependencies:
Now, run the tests and make sure they all pass:
bundle exec rake
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 open issues
- Hop into
#codebrawlon Freenode and ask. We're nice people ;)
- Find a
TODOin the source, so you can help clean up a bit
- Refactor existing code (that includes the front end too)
If you found something to work on, fork the project. Codebrawl uses git-flow, but don't let that scare you, you can just work in the develop branch. Now, add your changes and be sure to write specs for them. If you don't know how or get stuck somewhere, hop into #codebrawl on freenode.net and we'll help you out. When you're done, just send a pull request and we'll look at it as soon as possible.