Difference between revisions of "Documentation/Nightly/Developers/Tutorials/ContributePatch"

From Slicer Wiki
Jump to: navigation, search
m
Line 1: Line 1:
 
The following instructions describes the recommended workflow to contribute patch to Slicer code base.  
 
The following instructions describes the recommended workflow to contribute patch to Slicer code base.  
  
It is also assumed you followed the [[Documentation/4.1/Developers/StartHere#New_community_member_checklist|New community member checklist]] and have a clone of https://github.com/Slicer/Slicer/.
+
It is assumed you followed the [[Documentation/4.1/Developers/StartHere#New_community_member_checklist|New community member checklist]] and have a clone of https://github.com/Slicer/Slicer/.
 +
It is also assumed that you have setup the development environment as described in the [[Documentation/Nightly/Developers/DevelopmentWithGit#Slicer_Setup | Slicer Setup]] section.
  
 
'''If not already done, make sure to read the [[Documentation/{{documentation/version}}/Developers/Style_Guide|Slicer Coding Style Guide]] :-)'''
 
'''If not already done, make sure to read the [[Documentation/{{documentation/version}}/Developers/Style_Guide|Slicer Coding Style Guide]] :-)'''

Revision as of 14:35, 14 April 2013

Home < Documentation < Nightly < Developers < Tutorials < ContributePatch

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

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

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. Add a note to the issue with a link pointing to your topic. For example, see note 1906#c4578
  • 5. Send an email on the slicer-developers list pointing to the reported bug. Title of the email should start with [BUG <IssueNumber>] Title of the bug - <category>