Difference between revisions of "Documentation/Nightly/Developers/Tutorials/ContributePatch"
From Slicer Wiki
m |
m |
||
| Line 2: | Line 2: | ||
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 assumed that you followed the [[Documentation/Nightly/Developers/StartHere#New_community_member_checklist|New community member checklist]], have a clone of https://github.com/Slicer/Slicer/ and have setup the development environment as described | + | It is assumed that you followed the [[Documentation/Nightly/Developers/StartHere#New_community_member_checklist|New community member checklist]], have a clone of https://github.com/Slicer/Slicer/ and have setup the development environment as described [[Documentation/Nightly/Developers/DevelopmentWithGit#Slicer_Setup | here]]. |
| − | + | <!-- | |
'''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]] :-)''' | ||
| − | + | --> | |
<ol start="1" style="list-style-type: decimal;"> | <ol start="1" style="list-style-type: decimal;"> | ||
| Line 23: | Line 23: | ||
<li> | <li> | ||
| − | <p> | + | <p>Fix the code or implement your feature, then commit your change(s)</p> |
<ol style="list-style-type:none; border-left:thick solid red; padding-left:1em;"> | <ol style="list-style-type:none; border-left:thick solid red; padding-left:1em;"> | ||
<li>Make sure to read the [[Documentation/{{documentation/version}}/Developers/Style_Guide|Slicer Coding and Commit Style Guide]] </li> | <li>Make sure to read the [[Documentation/{{documentation/version}}/Developers/Style_Guide|Slicer Coding and Commit Style Guide]] </li> | ||
Revision as of 18:09, 9 July 2013
Home < 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.
Create an issue in the tracker. For example, see issue #1906
Make sure your fork has a git remote. Replace
jcfrwith your git login.git remote add jcfr git@github.com:jcfr/Slicer.git
Create a topic named
<issuer_number>-a-descriptive-topic-name. For example:git checkout -b 1906-uninstall-extensions-on-restart
-
Fix the code or implement your feature, then commit your change(s)
- Make sure to read the Slicer Coding and Commit Style Guide
Publish the topic on your fork
git push jcfr 1906-uninstall-extensions-on-restart
Add a note to the issue with a link pointing to your topic. For example, see note 1906#c4578
