Documentation/Nightly/Developers/Tutorials/Contribute Extension Description File - Revision history

Fbudin at 18:54, 9 December 2014

2014-12-09T18:54:52Z

Fbudin at 18:53, 9 December 2014

2014-12-09T18:53:20Z

Fbudin at 15:44, 9 December 2014

2014-12-09T15:44:06Z

JChris.FillionR: /* Extensions build against Slicer {{Documentation/currentversion}} */

2013-11-11T15:31:03Z

Extensions build against Slicer {{Documentation/currentversion}}

JChris.FillionR: /* Extensions build against Slicer trunk */

2013-11-11T15:30:25Z

Extensions build against Slicer trunk

JChris.FillionR at 16:42, 6 November 2013

2013-11-06T16:42:37Z

JChris.FillionR at 16:34, 6 November 2013

2013-11-06T16:34:55Z

JChris.FillionR: /* Contributing a new extension */

2013-11-06T16:33:20Z

Contributing a new extension

JChris.FillionR: /* Extensions build against Slicer trunk */

2013-11-06T16:32:23Z

Extensions build against Slicer trunk

JChris.FillionR: /* Extensions build against Slicer trunk */

2013-11-06T16:30:15Z

Extensions build against Slicer trunk

@@ Line 129: / Line 129: @@
 git remote add upstream git://github.com/Slicer/ExtensionsIndex   # Add reference to the authoritative ExtensionsIndex
 git fetch upstream                                                # Fetch change of the authoritative ExtensionsIndex
-git checkout 4.4                                                  # Checkout 4.4
+git checkout 4.3                                                  # Checkout 4.3
-git reset --hard upstream/4.4                                     # Reset your local 4.4 branch using the authoritative 4.4
+git reset --hard upstream/4.3                                     # Reset your local 4.3 branch using the authoritative 4.3
-git push origin 4.4                                               # Update the 4.4 branch of your online fork
+git push origin 4.3                                               # Update the 4.3 branch of your online fork
 </pre>
 <li><p>If needed, create branch named <code>update-YourExtensionName-{{Documentation/currentversion}}</code></p></li>
 <pre>
-git checkout -B update-YourExtensionName-4.4 4.4                  # Create branch update-YourExtensionName-4.4 or ensure the existing one starts of updated 4.4 branch.
+git checkout -B update-YourExtensionName-4.3 4.3                  # Create branch update-YourExtensionName-4.3 or ensure the existing one starts of updated 4.3 branch.
 </pre>
@@ Line 146: / Line 146: @@
 <li><p>Push modifications to your <code>ExtensionIndex</code> fork on github</p></li>
 <pre>
-git push origin update-YourExtensionName-4.4  --force             # Publish the updated branch on your fork
+git push origin update-YourExtensionName-4.3  --force             # Publish the updated branch on your fork
 </pre>

@@ Line 134: / Line 134: @@
 </pre>
-<li><p>If needed, create branch named <code>update-YourExtensionName-4.4</code></p></li>
+<li><p>If needed, create branch named <code>update-YourExtensionName-{{Documentation/currentversion}}</code></p></li>
 <pre>
 git checkout -B update-YourExtensionName-4.4 4.4                  # Create branch update-YourExtensionName-4.4 or ensure the existing one starts of updated 4.4 branch.
@@ Line 151: / Line 151: @@
 <li>
-   <p>Create a "Pull Request" using a link similar to the following: <code>https://github.com/USER/ExtensionsIndex/pull/new/update-YourExtensionName-4.4</code></p>
+   <p>Create a "Pull Request" using a link similar to the following: <code>https://github.com/USER/ExtensionsIndex/pull/new/update-YourExtensionName-{{Documentation/currentversion}}</code></p>
    <ol style="list-style-type:none; border-left:thick solid red; padding-left:1em;">

@@ Line 129: / Line 129: @@
 git remote add upstream git://github.com/Slicer/ExtensionsIndex   # Add reference to the authoritative ExtensionsIndex
 git fetch upstream                                                # Fetch change of the authoritative ExtensionsIndex
-git checkout 4.3                                                  # Checkout 4.3
+git checkout 4.4                                                  # Checkout 4.4
-git reset --hard upstream/4.3                                     # Reset your local 4.3 branch using the authoritative 4.3
+git reset --hard upstream/4.4                                     # Reset your local 4.4 branch using the authoritative 4.4
-git push origin 4.3                                               # Update the 4.3 branch of your online fork
+git push origin 4.4                                               # Update the 4.4 branch of your online fork
 </pre>
-<li><p>If needed, create branch named <code>update-YourExtensionName-4.3</code></p></li>
+<li><p>If needed, create branch named <code>update-YourExtensionName-4.4</code></p></li>
 <pre>
-git checkout -B update-YourExtensionName-4.3 4.3                  # Create branch update-YourExtensionName-4.3 or ensure the existing one starts of updated 4.3 branch.
+git checkout -B update-YourExtensionName-4.4 4.4                  # Create branch update-YourExtensionName-4.4 or ensure the existing one starts of updated 4.4 branch.
 </pre>
@@ Line 146: / Line 146: @@
 <li><p>Push modifications to your <code>ExtensionIndex</code> fork on github</p></li>
 <pre>
-git push origin update-YourExtensionName-4.3  --force             # Publish the updated branch on your fork
+git push origin update-YourExtensionName-4.4  --force             # Publish the updated branch on your fork
 </pre>
 <li>
-   <p>Create a "Pull Request" using a link similar to the following: <code>https://github.com/USER/ExtensionsIndex/pull/new/update-YourExtensionName-4.3</code></p>
+   <p>Create a "Pull Request" using a link similar to the following: <code>https://github.com/USER/ExtensionsIndex/pull/new/update-YourExtensionName-4.4</code></p>
    <ol style="list-style-type:none; border-left:thick solid red; padding-left:1em;">

@@ Line 146: / Line 146: @@
 <li><p>Push modifications to your <code>ExtensionIndex</code> fork on github</p></li>
 <pre>
-git push origin update-YourExtensionName-4.3                     # Publish the updated branch on your fork
+git push origin update-YourExtensionName-4.3  --force             # Publish the updated branch on your fork
 </pre>

@@ Line 93: / Line 93: @@
 <li><p>Push modifications to your <code>ExtensionIndex</code> fork on github</p></li>
 <pre>
-git push origin update-YourExtensionName                         # Publish the updated branch on your fork
+git push origin update-YourExtensionName --force                  # Publish the updated branch on your fork
 </pre>

@@ Line 96: / Line 96: @@
 </pre>
-<li><p>Create a pull request:</p></li>
+<li>
-* Visiting your fork on http://github.com/USER/ExtensionsIndex and, if available, clicking on the <code>Pull request</code> link as explained [https://help.github.com/articles/creating-a-pull-request here].
+  <p>Create a "Pull Request" using a link similar to the following: <code>https://github.com/USER/ExtensionsIndex/pull/new/update-YourExtensionName</code></p>
 Note: If you are using github for hosting your extension source code, make sure to associated a '''Compare View link''' showing the differences in the source code of your extension (NOT ExtensionIndex!!!) between the previous and current revisions. Compare link is very helpful to summarize the changes.
 <pre>
@@ Line 110: / Line 110: @@
 </pre>
 Source: http://jbuckley.ca/2011/09/githubs-compare-view/
 </ol>
 == Extensions build against Slicer {{Documentation/currentversion}}  ==
@@ Line 145: / Line 149: @@
 </pre>
-Note: If you are using github for hosting your extension source code, make sure to associated a '''Compare View link'''. This is very helpful to summarize the changes.
+<li>
 <pre>
 You can build the compare view URL manually with the following format:
@@ Line 161: / Line 166: @@
 As a concrete example, in [https://github.com/Slicer/ExtensionsIndex/commit/d8c064ea6f5b182fcf0b1b5c86c03afbd5853de5#diff-d5a6aa1d87d84077acf9eaf33bfcde05 this commit] the version of the LongitudinalPETCT extension was changed from 9b6d4b8 to d033772. The extension repository is located here: https://github.com/paulcm/LongitudinalPETCT/, and therefore the compare link is https://github.com/paulcm/LongitudinalPETCT/compare/9b6d4b8...d033772.
 </ol>
 <!--

@@ Line 38: / Line 38: @@
 git push origin add-YourExtensionName
 </pre>
-<li><p>On your github fork, click on "Pull Request". Slicer folks will be automatically notified. [https://help.github.com/articles/creating-a-pull-request Need help ?]</p></li>
+<li>
 <li><p>That's it !</p></li>

@@ Line 82: / Line 82: @@
    <p>Regenerate the <code>YourExtensionName.s4ext</code> file by configuring your extension with CMake</p>
    <ol style="list-style-type:none; border-left:thick solid red; padding-left:1em;">
-     <li><p> If the svn server needs a username and a password, edit the newly generated <code>YourExtensionName.s4ext</code> file to add this information</p></li>
+     <li><p> If the svn server needs a username and a password, edit the newly generated <code>YourExtensionName.s4ext</code> file specifying <code>svnusername</code> and <code>svnpassword</code></p></li>
    </ol>
 </li>

@@ Line 79: / Line 79: @@
 </pre>
-<li><p>Regenerate the <code>YourExtensionName.s4ext</code> file by configuring your extension with CMake</p></li>
+<li>
-* If the svn server needs a username and a password, edit the newly generated <code>YourExtensionName.s4ext</code> file to add this information
+  <p>Regenerate the <code>YourExtensionName.s4ext</code> file by configuring your extension with CMake</p>
 <li><p>Commit the <code>YourExtensionName.s4ext</code> file to your cloned ExtensionIndex repository (provide a meaningful commit comment)</p></li>
 <li><p>Push modifications to your <code>ExtensionIndex</code> fork on github</p></li>