Skip to content

Conversation

@sowwnn
Copy link

@sowwnn sowwnn commented Oct 22, 2025

New extension

Tier 1

Any extension that is listed in the Extensions Catalog must fulfill these requirements.

  • [ x ] Extension has a reasonable name (not too general, not too narrow, suggests what the extension is for). The extension name should not start with Slicer (unless it explicitly provides a bridge between Slicer and a tool or library), because it would make it more difficult to find extensions if the name of many started with the same word.
  • [ x ] Repository name is Slicer+ExtensionName (except if the repository that hosts the extension can be also used without Slicer)
  • [ x ] Repository is associated with 3d-slicer-extension GitHub topic so that it is listed here. To edit topics, click the settings icon in the right side of "About" section header and enter 3d-slicer-extension in "Topics" and click "Save changes". To learn more about topics, read https://help.github.com/en/articles/about-topics
  • [ x ] Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)
  • [ x ] Any known related patents must be mentioned in the extension description.
  • [ x ] LICENSE.txt is present in the repository root and the name of the license is mentioned in extension homepage. We suggest you use a permissive license that includes patent and contribution clauses. This will help protect developers and ensure the code remains freely available. MIT (https://choosealicense.com/licenses/mit/) or Apache (https://choosealicense.com/licenses/apache-2.0/) license is recommended. Read here to learn more about licenses. If source code license is more restrictive for users than MIT, BSD, Apache, or 3D Slicer license then describe the reason for the license choice and include the name of the used license in the extension description.
  • [ x ] Extension URL and revision (scmurl, scmrevision) is correct, consider using a branch name (main, release, ...) instead of a specific git hash to avoid re-submitting pull request whenever the extension is updated
  • [ x ] Extension icon URL is correct (do not use the icon's webpage but the raw data download URL that you get from the download button - it should look something like this: https://raw.githubusercontent.com/user/repo/main/SomeIcon.png)
  • [ x ] Screenshot URLs (screenshoturls) are correct, contains at least one
  • [ x ] Content of submitted json file is consistent with the top-level CMakeLists.txt file in the repository (dependencies, etc. are the same)
  • Homepage URL points to valid webpage containing the following:
    • [ x ] Extension name
    • [ x ] Short description: 1-2 sentences, which summarizes what the extension is usable for
    • [ x ] At least one nice, informative image, that illustrates what the extension can do. It may be a screenshot.
    • [ x ] Description of contained modules: at one sentence for each module
    • Publication: link to publication and/or to PubMed reference (if available)
  • Hide unused github features (such as Wiki, Projects, and Discussions, Releases, Packages) in the repository to reduce noise/irrelevant information:
    • [ x ] Click Settings and in repository settings uncheck Wiki, Projects, and Discussions (if they are currently not used).
    • [ x ] Click the settings icon next to About in the top-right corner of the repository main page and uncheck Releases and Packages (if they are currently not used)
  • The extension is safe:
    • [ x ] Does not include or download binaries from unreliable sources
    • [ x ] Does not send any information anywhere without user consent (explicit opt-in is required)

Tier 3

Community-supported extensions.

  • Documentation, tutorial, and test data are provided for most modules. A tutorial provides step-by-step description of at least the most typical use case, include a few screenshots. Any sample data sets that is used in tutorials must be registered with the Sample Data module to provide easy access to the user.
  • Follows programming and user interface conventions of 3D Slicer (e.g., GUI and logic are separated, usage of popups is minimized, no unnecessary custom GUI styling, etc.)
  • The extension can be successfully built and packaged on all supported platforms (Windows, macOS, Linux)
  • Maintainers respond to issues and pull request submitted to the extension's repository.
  • Maintainers respond to questions directly addressed to him/her via @mention on the Slicer Forum.
  • Permissive license is used for the main functions of the extension (recommended Apache or MIT). The extension can provide additional functionality in optional components that are distributed with non-permissive license, but the user has to explicitly approve those before using them (e.g., a pop-up can be displayed that explains the licensing terms and the user has to acknowledge them to proceed).
  • All requirements of tiers < 3.

Tier 5

Critically important extensions, supported by Slicer core developers. New Slicer Stable Release is released only if all Tier 5 extension packages are successfully created on all supported platforms.

  • Slicer core developers accept the responsibility of fixing any issues caused by Slicer core changes; at least one Slicer core developer (anyone who has commit right to Slicer core) must be granted commit right to the extension's repository.
  • Automated tests for all critical features.
  • Maintainers respond to questions related to the extension on the Slicer Forum.
  • All requirements of tiers < 5.

Copilot AI review requested due to automatic review settings December 11, 2025 07:13
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds a new extension called "SliceStat" to the 3D Slicer Extensions Catalog. The extension exports slice numbers for each segment in a segmentation node to a CSV file.

Key Changes:

  • New extension metadata file defining SliceStat extension properties
  • Extension categorized under "VsData" with basic configuration fields

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

extension_category = VsData
extension_homepage = https://github.com/sowwnn/Slicer_SliceStat
extension_scm_url = https://github.com/sowwnn/Slicer_SliceStat.git
extension_scm = git
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing the scmrevision field which specifies which branch or commit to use. According to the Tier 1 checklist, it's recommended to use a branch name (like "main" or "release") instead of a specific git hash to avoid re-submitting pull requests whenever the extension is updated.

Suggested change
extension_scm = git
extension_scm = git
scmrevision = main

Copilot uses AI. Check for mistakes.
@@ -0,0 +1,8 @@
[extension]
extension_name = SliceStat
extension_author = Sowwn (User)
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The author name appears to have a typo. "Sowwn" should likely be "Sown" unless this is intentional.

Suggested change
extension_author = Sowwn (User)
extension_author = Sown (User)

Copilot uses AI. Check for mistakes.
extension_name = SliceStat
extension_author = Sowwn (User)
extension_description = This extension exports the slice numbers for each segment in a segmentation node to a CSV file.
extension_category = VsData
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The category name "VsData" appears to be a typo or unclear. Standard 3D Slicer extension categories include names like "Informatics", "Registration", "Segmentation", "Quantification", etc. Consider using a more standard category name that better describes the extension's purpose, such as "Informatics" or "Quantification".

Suggested change
extension_category = VsData
extension_category = Informatics

Copilot uses AI. Check for mistakes.
extension_category = VsData
extension_homepage = https://github.com/sowwnn/Slicer_SliceStat
extension_scm_url = https://github.com/sowwnn/Slicer_SliceStat.git
extension_scm = git
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing the extension_icon_url field which is required according to the Tier 1 checklist ("Extension icon URL is correct"). The extension metadata should include an icon URL pointing to a raw image file (e.g., https://raw.githubusercontent.com/user/repo/main/SomeIcon.png).

Suggested change
extension_scm = git
extension_scm = git
extension_icon_url = https://raw.githubusercontent.com/sowwnn/Slicer_SliceStat/main/SliceStat.png

Copilot uses AI. Check for mistakes.
extension_description = This extension exports the slice numbers for each segment in a segmentation node to a CSV file.
extension_category = VsData
extension_homepage = https://github.com/sowwnn/Slicer_SliceStat
extension_scm_url = https://github.com/sowwnn/Slicer_SliceStat.git
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing the extension_screenshoturls field which is required according to the Tier 1 checklist ("Screenshot URLs (screenshoturls) are correct, contains at least one"). The extension metadata should include at least one screenshot URL.

Suggested change
extension_scm_url = https://github.com/sowwnn/Slicer_SliceStat.git
extension_scm_url = https://github.com/sowwnn/Slicer_SliceStat.git
extension_screenshoturls = https://github.com/sowwnn/Slicer_SliceStat/raw/main/docs/screenshot.png

Copilot uses AI. Check for mistakes.
@lassoan
Copy link
Contributor

lassoan commented Dec 18, 2025

Please use the new json extension description file format. See all the other extension descriptions as examples.

@lassoan lassoan changed the title New extension Add SliceStat extension Dec 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants