Documentation/Nightly/Developers/Tutorials/ContributePatch - Revision history

JChris.FillionR at 14:43, 31 January 2017

2017-01-31T14:43:04Z

JChris.FillionR at 22:57, 17 June 2016

2016-06-17T22:57:19Z

JChris.FillionR at 22:35, 16 June 2016

2016-06-16T22:35:31Z

JChris.FillionR at 15:49, 16 July 2013

2013-07-16T15:49:42Z

JChris.FillionR at 18:09, 9 July 2013

2013-07-09T18:09:19Z

JChris.FillionR at 18:06, 9 July 2013

2013-07-09T18:06:49Z

JChris.FillionR at 17:59, 9 July 2013

2013-07-09T17:59:56Z

JChris.FillionR at 18:32, 8 July 2013

2013-07-08T18:32:49Z

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:51:24Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

Sankhesh.jhaveri at 14:35, 14 April 2013

2013-04-14T14:35:52Z

@@ Line 9: / Line 9: @@
 <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>
+   <p>Create an issue in the [http://na-mic.org/Mantis/bug_report_page.php tracker] setting <i>severity</i> to <i>feature</i>. For example, see issue [http://na-mic.org/Mantis/view.php?id=1906 #1906]</p>
    {{remark|lightgreen|For simple changes (e.g typo, ...), this step is optional.}}
 </li>

@@ Line 10: / Line 10: @@
 <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>
-   <ol style="list-style-type:none; border-left:thick solid lightgreen; padding-left:1em;">
+   {{remark|lightgreen|For simple changes (e.g typo, ...), this step is optional.}}
 </li>
@@ Line 30: / Line 27: @@
 <li>
    <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;">
+   {{remark|red|Make sure to read the [[Documentation/{{documentation/version}}/Developers/Style_Guide|Slicer Coding and Commit Style Guide]]}}
 </li>

@@ Line 8: / Line 8: @@
 <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>
 <li><p>Make sure your clone has a [https://help.github.com/articles/adding-a-remote git remote]. After [https://help.github.com/articles/fork-a-repo forking Slicer repository], replace <code>jcfr</code> with your git login.</p>
@@ Line 35: / Line 41: @@
 </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>Create a [https://help.github.com/articles/creating-a-pull-request/ Pull Request] and 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>
 <!--

@@ Line 10: / Line 10: @@
 <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>
+<li><p>Make sure your clone has a [https://help.github.com/articles/adding-a-remote git remote]. After [https://help.github.com/articles/fork-a-repo forking Slicer repository], replace <code>jcfr</code> with your git login.</p>
 <pre>
 git remote add jcfr git@github.com:jcfr/Slicer.git

@@ Line 2: / Line 2: @@
 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 in the [[Documentation/Nightly/Developers/DevelopmentWithGit#Slicer_Setup | here]].
+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]] :-)'''
+-->
 <ol start="1" style="list-style-type: decimal;">
@@ Line 23: / Line 23: @@
 <li>
-   <p>Hack, hack, hack and commit your change</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;">
      <li>Make sure to read the [[Documentation/{{documentation/version}}/Developers/Style_Guide|Slicer Coding and Commit Style Guide]] </li>

@@ Line 6: / Line 6: @@
 '''If not already done, make sure to read the [[Documentation/{{documentation/version}}/Developers/Style_Guide|Slicer Coding Style Guide]] :-)'''
-* 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]
+<ol start="1" style="list-style-type: decimal;">
-* 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.
+<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>
 <pre>
 git remote add jcfr git@github.com:jcfr/Slicer.git
 </pre>
-* 3. Create a topic named <code>&lt;issuer_number&gt;-a-descriptive-topic-name</code>. For example:
+<li><p>Create a topic named <code>&lt;issuer_number&gt;-a-descriptive-topic-name</code>. For example:</p>
 <pre>
 git checkout -b 1906-uninstall-extensions-on-restart
 </pre>
-* 4. Hack, hack, hack and commit your change
+<li>
-* 5. Publish the topic on your fork
+<li><p>Publish the topic on your fork</p>
 <pre>
 git push jcfr 1906-uninstall-extensions-on-restart
 </pre>
-* 6. 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]
+<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>
 <!--
-* 7. 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>
+<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>
 -->

@@ Line 18: / Line 18: @@
 </pre>
-* 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. Hack, hack, hack and commit your change
-* 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>
+* 5. Publish the topic on your fork

← Older revision		Revision as of 07:51, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	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.

@@ Line 1: / Line 1: @@
 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/.
 '''If not already done, make sure to read the [[Documentation/{{documentation/version}}/Developers/Style_Guide|Slicer Coding Style Guide]] :-)'''