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

Lasso: moved to readthedocs

2020-06-08T20:39:19Z

moved to readthedocs

JChris.FillionR at 00:13, 6 June 2020

2020-06-06T00:13:03Z

JChris.FillionR: /* Contribution Checklist */

2019-01-07T20:05:49Z

Contribution Checklist

JChris.FillionR: /* Contribution Checklist */

2018-12-05T18:06:17Z

Contribution Checklist

JChris.FillionR: /* Contribution Checklist */

2018-12-05T18:05:55Z

Contribution Checklist

JChris.FillionR at 18:02, 5 December 2018

2018-12-05T18:02:05Z

Fedorov: /* Step-by-step: How to create, publish, distribute and maintain an extension ? */

2018-12-05T16:37:31Z

Step-by-step: How to create, publish, distribute and maintain an extension ?

Lasso: /* Step-by-step: How to create, publish, distribute and maintain an extension ? */

2018-10-09T22:48:25Z

Step-by-step: How to create, publish, distribute and maintain an extension ?

Lasso at 02:22, 6 September 2018

2018-09-06T02:22:03Z

Lasso at 02:17, 6 September 2018

2018-09-06T02:17:11Z

@@ Line 1: / Line 1: @@
 <noinclude>{{documentation/versioncheck}}</noinclude>
-{{TOC right}}
+{{documentation/banner
+| text  = [https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html This page has been moved to read-the-docs.]
-To learn what is an extension, see [[Documentation/Nightly/Developers/FAQ#What_is_an_extension_.3F|here]]
+| background-color = 8FBC8F }}

@@ Line 23: / Line 23: @@
 ** 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:
+* If you consider your extension is ready for distribution (see [https://github.com/Slicer/ExtensionsIndex/blob/master/.github/PULL_REQUEST_TEMPLATE.md contribution checklist]), 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

@@ Line 33: / Line 33: @@
 === Contribution Checklist ===
-* Wait for your pull request to be merged. Respond to comments posted on the pull request. Reviewers will associate the following checklist with your pull request:
+* Wait for your pull request to be merged. Respond to comments posted on the pull request. The [https://github.com/Slicer/ExtensionsIndex/blob/master/.github/PULL_REQUEST_TEMPLATE.md following checklist] will automatically be associated with your pull request.
 === Continuous Integration ===

@@ Line 50: / Line 50: @@
    * [ ] 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
-_This checklist was copied from the [Step-by-step: How to create, publish, distribute and maintain an extension ?](https://www.slicer.org/wiki/Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions#Contribution_Checklist) guide available Slicer wiki._
+_This checklist was copied from the [Step-by-step: How to create, publish, distribute and maintain an extension ?](https://www.slicer.org/wiki/Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions#Contribution_Checklist) guide available on the Slicer wiki._
 }}
 * 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.

@@ Line 33: / Line 33: @@
 === Contribution Checklist ===
-* Wait for your pull request to be merged. Respond to comments posted on the pull request. Reviewers will check the followings:
+* Wait for your pull request to be merged. Respond to comments posted on the pull request. Reviewers will associate the following checklist with your pull request:
-** Extension has a reasonable name (not too general, not too narrow, suggests what the extension is for)
+{{pre2|
-** Repository name is Slicer<ExtensionName>
+Thank you very much for your contribution. Here is list of minimum requirements that are necessary to give users a chance to find out what your extension is about and how to use it:
-** 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 has a reasonable name (not too general, not too narrow, suggests what the extension is for)
-** Extension icon URL is correct
+* [ ] Repository name is `Slicer<ExtensionName>`. However, this is not a mandatory requirement. If there is a compelling reason not to use Slicer prefix, please make a note while making the pull request.
-** Screenshot URLs (screenshoturls) are correct, contains at least one
+* [ ] Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)
-** Homepage URL points to valid webpage containing the followings:
+* [ ] 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 name
+* [ ] Extension icon URL is correct
-*** Short description: 1-2 sentences, which summarizes what the extension is usable for
+* [ ] Screenshot URLs (`screenshoturls`) are correct, contains at least one
-*** At least one nice, informative image, that illustrates what the extension can do. It may be a screenshot.
+* [ ] Homepage URL points to valid webpage containing the followings:
-*** Description of contained modules: at least one sentence for each module
+  * [ ] Extension name
-*** 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
+  * [ ] Short description: 1-2 sentences, which summarizes what the extension is usable for
 * 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.

@@ Line 9: / Line 9: @@
 * 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).
+* 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: