Difference between revisions of "Documentation/Nightly/Developers/Tutorials/ContributePatch"
From Slicer Wiki
m |
m |
||
| Line 6: | Line 6: | ||
'''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;"> | |
| − | + | <li><p>Create an issue in the [http://na-mic.org/Mantis/bug_report_page.php tracker]. For example, see issue [http://na-mic.org/Mantis/view.php?id=1906 #1906]</p></li> | |
| + | |||
| + | <li><p>Make sure your fork has a [https://help.github.com/articles/adding-a-remote git remote]. Replace <code>jcfr</code> with your git login.</p> | ||
<pre> | <pre> | ||
git remote add jcfr git@github.com:jcfr/Slicer.git | git remote add jcfr git@github.com:jcfr/Slicer.git | ||
</pre> | </pre> | ||
| + | </li> | ||
| − | + | <li><p>Create a topic named <code><issuer_number>-a-descriptive-topic-name</code>. For example:</p> | |
<pre> | <pre> | ||
git checkout -b 1906-uninstall-extensions-on-restart | git checkout -b 1906-uninstall-extensions-on-restart | ||
</pre> | </pre> | ||
| + | </li> | ||
| − | + | <li> | |
| + | <p>Hack, hack, hack and commit your change</p> | ||
| + | <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> | ||
| + | </ol> | ||
| + | </li> | ||
| − | + | <li><p>Publish the topic on your fork</p> | |
<pre> | <pre> | ||
git push jcfr 1906-uninstall-extensions-on-restart | git push jcfr 1906-uninstall-extensions-on-restart | ||
</pre> | </pre> | ||
| + | </li> | ||
| − | + | <li><p>Add a note to the issue with a link pointing to your topic. For example, see note [http://na-mic.org/Mantis/view.php?id=1906#c4578 1906#c4578]</p></li> | |
<!-- | <!-- | ||
| − | + | <li><p>Send an email on the [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel slicer-developers] list pointing to the reported bug. Title of the email should start with <code>[BUG <IssueNumber>] Title of the bug - <category></code></p></li> | |
--> | --> | ||
| + | |||
| + | </ol> | ||
Revision as of 18:06, 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 in the here.
If not already done, make sure to read the Slicer Coding Style Guide :-)
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
-
Hack, hack, hack and commit your change
- 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
