|
Tags: 2017 source edit, Replaced |
| (5 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| | <noinclude>{{documentation/versioncheck}}</noinclude> | | <noinclude>{{documentation/versioncheck}}</noinclude> |
| | | | |
| − | To learn what is an extension, see [[Documentation/Nightly/Developers/FAQ#What_is_an_extension_.3F|here]]
| + | {{documentation/banner |
| − | | + | | text = [https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html This page has been moved to read-the-docs.] |
| − | == Step-by-step: How to create, publish, distribute and maintain an extension ? ==
| + | | background-color = 8FBC8F }} |
| − | | |
| − | * Scan through the [[Documentation/{{documentation/version}}/FAQ/Extensions|user]] and [[Documentation/{{documentation/version}}/Developers/FAQ/Extensions|developer]] extension FAQs
| |
| − | * Inform a community about your plans on the [https://discourse.slicer.org Slicer forum] to get information about potential parallel efforts (other developers may already work on a similar idea and you could join or build on each other's work), past efforts (related tools might have been available in earlier Slicer versions or in other software that you may reuse), and get early feedback from prospective users. You may also seek advice on the name of your extension and how to organize features into modules. All these can save you a lot of time in the long term.
| |
| − | * Optional (required if developing loadable or CLI [[Documentation/{{documentation/version}}/Developers/Modules|module types]]): [[Documentation/{{documentation/version}}/Developers/Build_Instructions|Build Slicer application]] in <code>Release</code>. Not needed if you only develop Python modules.
| |
| − | * Use the Extension Wizard module in Slicer to create an extension that will contain your module(s). Learn more about ExtensionWizard capabilities [[Documentation/{{documentation/version}}/Developers/ExtensionWizard|here]]. To learn about extension description file format see [[Documentation/{{documentation/version}}/Developers/Extensions/DescriptionFile|here]]
| |
| − | * Upload source code of your extension to a publicly available repository. It is recommended to start the repository name with "Slicer" (to make Slicer extensions easier to identify) followed by your extension name (for example, "Sequences" extension is stored in "SlicerSequences" repository). However, this is not a mandatory requirement. If you have a compelling reason not to use Slicer prefix, please make a note while making the pull request.
| |
| − | ** GitHub is recommended (due to large user community, free public project hosting): join [https://github.com/join Github] and [https://help.github.com/articles/set-up-git#set-up-git setup Git]
| |
| − | ** Extension Wizard command-line interface can upload source code of your extension to GitHub:
| |
| − | {{pre2|<nowiki>$ bin/slicerExtensionWizard --publish ~/Slicer-MyExtension/</nowiki>}}
| |
| − | * Implement your extension. <code>Hack, hack, hack :)</code>.
| |
| − | * Create documentation page for your extension
| |
| − | ** It is recommended to put documentation in a README.md file in your repository use the Slicer wiki: [[Documentation/{{documentation/version}}/Developers/Tutorials/DocumentExtension#Extension_page|Create a documentation page for your extension]].
| |
| − | * Optional (only needed, if you want to upload test data to MIDAS or troubleshoot extension upload problems): [[Documentation/{{documentation/version}}/Developers/Tutorials/ObtainExtensionServerApiKey|Create an account on the extension server and obtain an API Key]]. You will then use your midas login and api key to substitute <code><YOUR-MIDAS-LOGIN></code> and <code><YOUR-MIDAS-APIKEY></code> in the examples. Go to [http://slicer.kitware.com/midas3/community/23 NA-MIC community] and click on <code>Join community</code></p></li>
| |
| − | * Optional (required for loadable and CLI modules): [[Documentation/{{documentation/version}}/Developers/FAQ/Extensions#How_to_build_an_extension_.3F|Build your extension]]
| |
| − | * Test your extension:
| |
| − | ** If you have built your extension then build the PACKAGE target to create a package file that you can install from the Extension Manager by clicking the small tool icon in the top-right corner.
| |
| − | ** If you have not built your extension then set up your extension manually: [[Documentation/{{documentation/version}}/Developers/FAQ#How_to_manually_install_an_extension.3F|Build your extension]]
| |
| − | * If you consider your extension is ready for distribution, contribute it to the ExtensionsIndex:
| |
| − | ** Fork ExtensionIndex repository on GitHub by clicking ''Fork'' button on https://github.com/Slicer/ExtensionsIndex page
| |
| − | ** Add your .s4ext file to your forked repository: it can be done using a git client or simply by clicking ''Upload files'' button
| |
| − | ** Create a pull request: by clicking ''Create pull request'' button
| |
| − | ** Note: the [[Documentation/Nightly/Developers/ExtensionWizard|Extension Wizard]] can automate this by the following command:
| |
| − | | |
| − | {{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute ~/Slicer-MyExtension/</nowiki>}}
| |
| − | | |
| − | * Wait for your pull request to be merged. Respond to comments posted on the pull request. Reviewers will check the followings:
| |
| − | ** Extension has a reasonable name (not too general, not too narrow, suggests what the extension is for)
| |
| − | ** Repository name is Slicer<ExtensionName>
| |
| − | ** Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)
| |
| − | ** Extension URL and revision (scmurl, scmrevision) is correct, consider using a branch name (master, release, …) instead of a specific git has to avoid re-submitting pull request whenever the extension is updated
| |
| − | ** Extension icon URL is correct
| |
| − | ** Screenshot URLs (screenshoturls) are correct, contains at least one
| |
| − | ** Homepage URL points to valid webpage containing the followings:
| |
| − | *** Extension name
| |
| − | *** Short description: 1-2 sentences, which summarizes what the extension is usable for
| |
| − | *** At least one nice, informative image, that illustrates what the extension can do. It may be a screenshot.
| |
| − | *** Description of contained modules: at least one sentence for each module
| |
| − | *** Tutorial: step-by-step description of at least the most typical use case, include a few screenshots, provide download links to sample input data set
| |
| − | * Next day after your pull request is merged, check on the [https://www.slicer.org/wiki/Documentation/Nightly/Developers dashboard] if your extension is built successfully on all platforms.
| |
| − | | |
| − | === Continuous Integration ===
| |
| − | | |
| − | If you shared your extension by using the ExtensionWizard, make sure you know about the Slicer testing dashboard:
| |
| − | | |
| − | <p class="mw-code"> [[{{tool|logo|cdash}}|x25px]] http://slicer.cdash.org/index.php?project=Slicer4&display=project</p>
| |
| − | | |
| − | The dashboard will attempt to check out the source code of your extension, build, test and package it on Linux, MacOSX and Windows platforms.
| |
| − | | |
| − | | |
| − | To find your extension, use the following link replacing <code>Slicer-MyExtension</code> with the name of your extension:
| |
| − | | |
| − | <pre>
| |
| − | http://slicer.cdash.org/index.php?project=Slicer4&filtercount=1&showfilters=1&field1=buildname&compare1=63&value1=Slicer-MyExtension
| |
| − | </pre>
| |
| − | | |
| − | For example, here is the link to check the status of the <code>SlicerDMRI</code> extension:
| |
| − | | |
| − | <p class="mw-code">http://slicer.cdash.org/index.php?project=Slicer4&filtercount=1&showfilters=1&field1=buildname&compare1=63&value1=SlicerDMRI</p>
| |
| − | | |
| − | If you see red in any of the columns for your extension, click on the hyperlinked number of errors to see the details.
| |
| − | | |
| − | Always check the dashboard after you first introduce your extension, or after you make any changes to the code!
| |
