Slicer3:Contributing codes to Slicer3

From Slicer Wiki
Jump to: navigation, search
Home < Slicer3:Contributing codes to Slicer3


The goal of this page is to give quick instructions on how to download Slicer3 from the Subversion Control (SVN) server, and contribute code by committing changes back to SVN. More general instructions for developers are available here.

If you are interested in contributing to Slicer3, please contact the slicer-devel mailing list with information about what you have in mind.

Also, consider using the extension mechanism to prototype new functionality.

See this page for more information about subversion.

See also this information on using git's interface to svn for slicer3 development.

How to obtain Slicer 3 code from SVN

The Slicer3 svn repository sits on a server at Brigham and Women's Hospital in Boston. You can check out code to your local machine by:

svn co Slicer3

You don't need to obtain an account discussed below if you don't intend to commit code back to the sever, but we enthusiastically invite you to do so.

How to commit code

First, fill this form and under Comment type Request password for Slicer. Once you have write access to SVN, you can work with the repository using the following commands:

To update your local copy from the repository:

svn update

To check the current state of your local copy:

svn status

To check the current state compared to the repository:

svn -u status

To add a new file, first register it with the repository:

svn add filename

and then (very important):

svn commit -m "ENH: Adding a new file for X" filename

To remove a file:

svn remove filename

To rename a file:

svn move oldfilename newfilename

If the update results in a conflict, fix the file first before commiting it.

Once you have fixed the file:

svn resolved filename

GUI tools for easy SVN handling

It is handy to use a GUI tool for SVN. I particulary like a cross-platform GUI tool called RapidSVN.