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 here.

1. Create an issue in the tracker setting severity to feature. For example, see issue #1906

   1. For simple changes (e.g typo, ...), this step is optional.

2. Make sure your clone has a git remote. After forking Slicer repository, 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. Fix the code or implement your feature, then commit your change(s)

   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. Create a Pull Request and add a note to the issue with a link pointing to your topic. For example, see note 1906#c4578