Checking out the source

The Subversion repository resides at http://dev.michaux.ca/svn/fork

Check out the current development version of the Fork JavaScript files:

svn co http://dev.michaux.ca/svn/fork/trunk/public/javascripts/fork

Check out the current development version of the Fork plug-in for Ruby on Rails:

svn co http://dev.michaux.ca/svn/fork/trunk/vendor/plugins/fork

Check out the current development version of the entire Fork site including the JavaScript. This is a Rails application with all the Fork test pages included.

svn co http://dev.michaux.ca/svn/fork/trunk

Tags are just where you would expect them to be

http://dev.michaux.ca/svn/fork/tags/

Creating a patch

Tickets are fine, but patches are great. If you want to modify Fork or fix a bug you've run across, there's no faster way to make it happen than to do it yourself. You can submit patches to any aspect of this project but the priority is that code standards will be kept high in preference to new features being added. Please keep patches small and focused.

  1. Get Fork ready for patching
    1. Check out the latest version of the Fork site: svn co http://dev.michaux.ca/svn/fork/trunk
    2. Fire up the Rails app
    3. Ensure that the existing tests pages pass.
  2. Make a test-driven change
    1. Add or change tests to prove that your change works.
    2. Make the change to the source.
    3. Use jslint to ensure that the source can be minimized with jsmin
    4. Verify that all tests pass in all browsers. This is the tedious part of browser scripting.
  3. Share your well-tested change
    1. Sanity check the changes you've made: svn status
    2. Create a patch: svn diff > my_descriptively_named_patch.diff
    3. Create a new ticket with [PATCH] as the first word in the summary. Attach your patch file.
    4. Keep an eye on the ticket and address concerns that arise. Make your change hard not to commit.
  4. Bask in the glory of being a Fork contributor!

Source style

This page adapted from http://dev.rubyonrails.org