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

From Slicer Wiki
Jump to: navigation, search
m
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(12 intermediate revisions by one other user not shown)
Line 1: Line 1:
<br>
+
<noinclude>{{documentation/versioncheck}}</noinclude>
 +
The following instructions describes the recommended workflow to contribute patch to Slicer code base.
  
The following instructions describes what should be 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 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/.
  
  
 
* 1. 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]
 
* 1. 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]
  
* 2. Make sure your fork is a [https://help.github.com/articles/adding-a-remote git remote]. Replace <code>jcfr</code> with your git login.
+
* 2. Make sure your fork has a [https://help.github.com/articles/adding-a-remote git remote]. Replace <code>jcfr</code> with your git login.
 
<pre>
 
<pre>
 
git remote add jcfr git@github.com:jcfr/Slicer.git
 
git remote add jcfr git@github.com:jcfr/Slicer.git
Line 18: Line 19:
 
* 4. 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]
 
* 4. 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]
  
* 5. Send an email on the [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel slicer-developers] list pointing to the reported bug.
+
* 5. 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>

Latest revision as of 07:30, 14 June 2013

Home < Documentation < 4.1 < 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 also assumed you followed the New community member checklist and have a clone of https://github.com/Slicer/Slicer/.


  • 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>