[Home]FreeDom/Contributing

ec2-18-223-114-142.us-east-2.compute.amazonaws.com | ToothyWiki | FreeDom | RecentChanges | Login | Webcomic

You too can help out with FreeDom! Check out the [Readme] [files] on GitHub?, and see if there's something you want to lend a hand with.

When you've decided here's what you need to do:

  1. Sign up for GitHub?. You can't (easily) contribute code to the project without a GitHub? account.
  2. Get your system set up for Rails development. On Windows, that's as simple as grabbing and running [the Rails Installer]
    1. Choose to set up git and ssh at the end; follow github's instructions on these, and register your public key with your github account
  3. Following github's instructions, fork the appropriate branch of FreeDom; and clone the fork to your dev machine
  4. From within the repository's root, run "bundle install --without production". It should complete without error
  5. Now run "bundle exec rake db:migrate" and "bundle exec rake db:migrate RAILS_ENV=test"
  6. To start a local server, run "bundle exec rails server"; after a minute or so (you need about 7 lines of log to appear), the server will be on 127.0.0.1:3000
  7. To run the Cucumber tests on the improve-testing branch, run "bundle exec rake:cucumber"; or "bundle exec cucumber -r features features/cards/base_game/witch.feature" for a specific card
  8. Make changes!
  9. Once you've got an integratable patch, push it to your github repository, and follow github's instructions for issuing a pull request back to me.

ec2-18-223-114-142.us-east-2.compute.amazonaws.com | ToothyWiki | FreeDom | RecentChanges | Login | Webcomic
This page is read-only | View other revisions | Recently used referrers
Last edited May 17, 2012 9:01 pm (viewing revision 1, which is the newest) (diff)
Search: