Getting the source
The Subversion repository is located at http://svn.collaboa.org/svn/collaboa/
To check out the trunk issue the following command:
svn co http://svn.collaboa.org/svn/collaboa/trunk/ collaboa
Which will check out a working copy into the current directory
Submitting patches and reporting bugs
Since Collaboa is self-hosted you can access the development tracker at dev.collaboa.org
Tickets are fine, but patches that include tests are the most helpful. If you want to modify Collaboa or fix a bug you’ve run across, there’s no faster way to make it happen than to do it yourself. Collaboa thrives on the generous work of many contributors. Won’t you become one of them?
- Check out the latest source:
svn co http://svn.collaboa.org/svn/collaboa/trunk/ collaboa - Ensure that the existing tests pass.
rake test - Make a test-driven change
- Add tests that will prove your change works. That is, they should be failing until you complete your change.
- Make your change to the source.
- Verify that your new tests now pass and all prior tests still pass.
- Share your well-tested change
- Sanity check the changes you’ve made:
svn status. - Create a patch:
svn diff > my_descriptively_named_patch.diff - On dev.collaboa.org, create a new ticket with [PATCH] as the first word in the summary. Attach your patch file.
- Keep an eye on the ticket and address concerns that arise. Make your change hard not to commit.
- Sanity check the changes you’ve made:
Source style
- Two spaces, no tabs
- Don’t use
andandorfor boolean tests, instead always use&&and|| MyClass.my_method(my_arg)—notmy_method( my_arg )ormy_method my_arg- Trivial parentheses may be omitted, like
before_filter :foobut not in cases like@person = Person.find :first, :conditions... - Follow the conventions you see used in the source already
