Important information!!
We are currently developing on the major_new_version branch, which is moving up to Rails 2.3.2.
We are taking out Globalize, using Time.zone properly, and becoming RESTful.

Useful links

To those who want to help fix MyChores, here are some links that you might find useful:

• Lighthouse tickets
• Exceptions are tweeted to exceptional_mc on Twitter
• MyChores journal

Forking the repository

If you want to submit modifications i advise you make a fork so that you have your own copy to work with.

Clone your fork on to your local machine. Use your private clone URL which begins git@

git clone git@github.com:yourname/mychores.git cd mychores git submodule init git submodule update

You’ll see an “origin” repository refers to your own fork. When you push to it, you’ll update GitHub with your changes. You probably also want to add the “official” mychores repository so that you can pull in changes that other people have made. GitHub recommends you call it “upstream”.

git remote add upstream git://github.com/sermoa/mychores.git git fetch upstream

Getting ready

Create yourself an environment and a database config file.

cp config/environment.sample.rb config/environment.rb cp config/database.sample.yml config/database.yml

Note that you may need to change your socket in the database config file.

Don’t worry about getting a recaptcha API key. It only applies in production mode.

If you don’t already have these, you’ll need to install some gems.

gem install hoe mocha nokogiri term-ansicolor treetop diff-lcs rake gems:build

Create your databases

rake db:create:all rake db:schema:load rake db:test:prepare

Run add_pictures.sql to load the public pictures into your database:

mysql -u root mychores_development < db/add_pictures.sql

Running specs and tests

rake spec rake features

You may still see some TimeZone deprecation warnings whilst we work on tidying up all that.

Pull request

When you have made some changes and pushed them to your fork, you can send me a pull request. I will review your changes and if they are good and useful i will merge them into MyChores.

Keeping up to date with latest code

You’ll probably want to merge in the upstream changes from time to time. That keeps your fork of the project up to date. You can do this by:

git fetch upstream git merge upstream/major_new_version

Oh, happy day! :)