Documentation/Nightly/Developers/Tutorials/ContributePatch

For the latest Slicer documentation, visit the read-the-docs.

The following instructions describes the recommended workflow to contribute patch to Slicer code base.

It is assumed that you followed the New community member checklist, have a clone of https://github.com/Slicer/Slicer/ and have setup the development environment as described in the here.

If not already done, make sure to read the Slicer Coding Style Guide :-)

1. Create an issue in the tracker. For example, see issue #1906

2. Make sure your fork has a git remote. Replace jcfr with your git login.

   git remote add jcfr git@github.com:jcfr/Slicer.git
   

3. Create a topic named <issuer_number>-a-descriptive-topic-name. For example:

   git checkout -b 1906-uninstall-extensions-on-restart
   

4. Hack, hack, hack and commit your change

   1. Make sure to read the Slicer Coding and Commit Style Guide

5. Publish the topic on your fork

   git push jcfr 1906-uninstall-extensions-on-restart
   

6. Add a note to the issue with a link pointing to your topic. For example, see note 1906#c4578