Documentation/Nightly/Developers/Tutorials/Contribute Extension Description File

From Slicer Wiki
Jump to: navigation, search
Home < Documentation < Nightly < Developers < Tutorials < Contribute Extension Description File

Contributing a new extension

Extensions build against Slicer trunk

The following instruction describes how to contribute extension description file for an extension being built against slicer trunk.

  1. Fork the ExtensionsIndex: http://github.com/Slicer/ExtensionsIndex. Click here for forking instructions.

  2. Clone your fork, then create a topic named add-<ExtensionName>

    3. git clone git@github.com:USER/ExtensionsIndex SlicerExtensionsIndex
cd SlicerExtensionsIndex
git checkout -b add-YourExtensionName

  3. Commit your description file. Commit title should be Add YourExtensionName extension and the content should provide details about the extension.

  4. Push the topic to your fork

    5. git push origin

  5. On your github fork, click on "Pull Request". Slicer folks will be automatically notified.

  6. That's it !



Extensions build against Slicer 4.10

Requesting an extension update

On your local fork, the idea is to create the following topic branches:

  • update-<YourExtensionName> based of master integration branch.
  • update-<YourExtensionName>-4.2 based of 4.2 integration branch.


Extensions build against Slicer trunk

The following instruction describes how to contribute extension description file updates for an extension being built against slicer trunk.

  1. Update the master branch of both your local clone and your online ExtensionsIndex fork

    2. 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 master                                               # Checkout master
git reset --hard upstream/master                                  # Reset your local master branch using the authoritative master 
git push origin master                                            # Update the master branch of your online fork

  2. If needed, create branch named update-YourExtensionName

    3. git checkout -b update-YourExtensionName                          # Create branch update-YourExtensionName

  3. Regenerate the YourExtensionName.s4ext file by configuring your extension with CMake

  4. Commit the YourExtensionName.s4ext file to your cloned ExtensionIndex repository (provide a meaningful commit comment)

  5. Push modifications to your ExtensionIndex fork on github

    6. git push origin update-YourExtensionName                         # Publish the updated branch on your fork

  6. Create a pull request:

    7. or

    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. 

    You can build the compare view URL manually with the following format: 

https://github.com/USER/REPO/compare/[USER:]GIT-REF…[USER:]GIT-REF

USER is your GitHub username, REPO is your GitHub repository, and GIT-REF can be a tag, branch, or commit SHA1.

    Source: http://jbuckley.ca/2011/09/githubs-compare-view/

Extensions build against Slicer 4.10

The following instruction describes how to contribute extension description file updates for an extension being built against slicer trunk.

  1. Update the 4.10 branch of both your local clone and your online ExtensionsIndex fork

    2. 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.2                                                  # Checkout 4.2
git reset --hard upstream/4.2                                     # Reset your local 4.2 branch using the authoritative 4.2
git push origin 4.2                                               # Update the 4.2 branch of your online fork

  2. If needed, create branch named update-YourExtensionName-4.2

    3. git checkout -b update-YourExtensionName-4.2                      # Create branch update-YourExtensionName-4.2


  3. Regenerate the YourExtensionName.s4ext file by configuring your extension with CMake

  4. Commit the YourExtensionName.s4ext file to your cloned ExtensionIndex repository providing a meaningful commit comment.

  5. Push modifications to your ExtensionIndex fork on github

    6. git push origin update-YourExtensionName-4.2                     # Publish the updated branch on your fork

  6. Create a pull request:

    7. or

    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. 

    You can build the compare view URL manually with the following format: 

https://github.com/USER/REPO/compare/[USER:]GIT-REF…[USER:]GIT-REF

USER is your GitHub username, REPO is your GitHub repository, and GIT-REF can be a tag, branch, or commit SHA1.

    Source: http://jbuckley.ca/2011/09/githubs-compare-view/


Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/Nightly/Developers/Tutorials/Contribute_Extension_Description_File&oldid=32009"