Instiki
How To Contribute (changes)

Showing changes from revision #14 to #15: Added | Removed

Instiki thrives on contributions from people around the world.
Anonymous reporting is enabled again.

Steps:

1. Create a ticket describing the bug or proposed change. To rely on someone else to make the change, stop here.
   Let’s say the ticket has ID 12345 (though hopefully we’ll never reach a five-digit bug count).
2. Check out fresh SVN sources:
   This project’s SVN repository can be checked out through anonymous access with the following command(s).
   

    $ svn checkout svn://rubyforge.org/var/svn/instiki/instiki/trunk instiki 

3. If you have developer access, to checkout the trunk, run the following command:
   

    $ svn checkout svn+ssh://developer@rubyforge.org/var/svn/instiki/instiki/trunk instiki
   

4. Run rake db:migrate to setup the database
5. Run automated tests: †
   

   $ cd instiki; rake
   Finished in 0.907 seconds.
   
   118 tests, 513 assertions, 0 failures, 0 errors
   

6. Make the changes you want.
7. Run automated tests again
8. Create a patch:
   

   svn diff > patch.12345.diff

   
   NB: Please follow this naming convention for your patches:
   

   patch.12345.diff - first patch for the ticket #12345
   patch.12345.diff.2 - second patch (maybe first failed)
   patch.12345.diff.3 - third... (it better stop here!)
   

9. Upload the patch to the coresponding ticket
10. Add prefix [PATCH] to the ticket title, to make it show up in the Trac patches report.

That’s all. Please update relevant unit tests and follow coding conventions that you spot.

Please submit art work and stylesheet tweaks by following the patch creation steps, too.

† It’s important to make sure the copy of Instiki you pull out from the repository actually passes all of its tests without any of your changes. This will prevent you from spending endless hours of trying to find where that bug is in your code if it really isn’t in your code.