Difference between revisions of "Documentation/Labs/EasyExtensionContribution"

From Slicer Wiki
Jump to: navigation, search
m
(Undo revision 37377 by JChris.FillionR (Talk))
 
Line 1: Line 1:
 +
The current process to contribute a new or updated [[Documentation/Nightly/Developers/Extensions/DescriptionFile|extension description file (*.s4ext)]] is documented [[Documentation/Nightly/Developers/Tutorials/Contribute_Extension_Description_File|here]].
  
  
This page serves as roadmap for the Slicer Extensions project.
+
We all agree it involves a lot of steps. To simplify this process, the idea would be to provide a set of git custom command automating most of it.
  
= Roadmap =
 
  
== Extension contribution process ==
 
  
=== In progress ===
+
The proposed improvement would be:
  
=== Done ===
+
1. Clone the ExtensionsIndex
  
=== To be done ==
+
2. Checkout either <code>master</code> or <code>4.3</code> branch
  
== Extension catalog ==
+
3. run <code>./Utilities/SetupForDevelopment.sh</code>
  
=== In progress ===
+
4. run this command:
* [http://na-mic.org/Mantis/view.php?id=3564 3564: Add search option in extension manager]
 
  
=== Done ===
+
    git prepare-extension-update /path/to/description-file.s4ext
  
=== To be done ==
+
This would:
 +
* locally create the topic "update-<ExtensionName>[-X.Y]" or "add-<ExtensionName>[-X.Y]"
 +
* generate meaningful commit message if possible (for svn and git based repo)
 +
* associate compare link if possible
  
== Extension manager ==
+
5. Then, if everything look good:
  
=== To be done ===
+
  git push-extension-update
*
+
 
*
+
This would publish the topic on your fork and submit the pull request
*
 

Latest revision as of 17:46, 27 February 2014

Home < Documentation < Labs < EasyExtensionContribution

The current process to contribute a new or updated extension description file (*.s4ext) is documented here.


We all agree it involves a lot of steps. To simplify this process, the idea would be to provide a set of git custom command automating most of it.


The proposed improvement would be:

1. Clone the ExtensionsIndex

2. Checkout either master or 4.3 branch

3. run ./Utilities/SetupForDevelopment.sh

4. run this command:

   git prepare-extension-update /path/to/description-file.s4ext

This would:

  • locally create the topic "update-<ExtensionName>[-X.Y]" or "add-<ExtensionName>[-X.Y]"
  • generate meaningful commit message if possible (for svn and git based repo)
  • associate compare link if possible

5. Then, if everything look good:

  git push-extension-update

This would publish the topic on your fork and submit the pull request