Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create SlicerMedicalReportGrading.json #2112

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gingerbread000
Copy link

@gingerbread000 gingerbread000 commented Nov 13, 2024

This 3D Slicer plugin is designed to assist in reading images and corresponding reports, and providing options to rate the reports within the 3D Slicer platform.

New extension

  • Extension has a reasonable name (not too general, not too narrow, suggests what the extension is for)
  • Repository name is Slicer+ExtensionName
  • 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
  • Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)
  • Any known related patents must be mentioned in the extension description.
  • LICENSE.txt is present in the repository root. MIT (https://choosealicense.com/licenses/mit/) or Apache (https://choosealicense.com/licenses/apache-2.0/) license is recommended. If source code license is more restrictive for users than MIT, BSD, Apache, or 3D Slicer license then the name of the used license must be mentioned in the extension description.
  • 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
  • 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)
  • Screenshot URLs (screenshoturls) are correct, contains at least one
  • Homepage URL points to valid webpage containing the following:
    • 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 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
    • Publication: link to publication and/or to PubMed reference (if available)
    • License: 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. We suggest you use the Slicer License or the Apache 2.0. Always mention in your README file the license you have chosen. If you choose a different license, explain why to the extension maintainers. Depending on the license we may not be able to host your work. Read here to learn more about licenses.
    • Content of submitted json file is consistent with the top-level CMakeLists.txt file in the repository (dependencies, etc. are the same)
  • Hide unused features in the repository to reduce noise/irrelevant information:
    • Click Settings and in repository settings uncheck Wiki, Projects, and Discussions (if they are currently not used)
    • 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)

@gingerbread000
Copy link
Author

We are developing an evaluation plugin. The plugin is mainly used to assess the accuracy of reports generated by AI. The plugin currently needs to be distributed to some collaborating doctors for use and testing.

@lassoan
Copy link
Contributor

lassoan commented Nov 16, 2024

Thank you for your contribution. I'm trying to figure out if this extension is something that can be relevant for the community (if it is only useful for a specific task for a specific project then other distribution mechanisms can be considered).

  • Provide a simple step-by-step description of how I can test the module. I loaded MRHead sample data set. Selected it in the module as Input volume. What can I do with the module then?
  • Rename PushButton to the actual button name
  • Add actual sample data (nifti file and corresponding json file?)
  • Module name (folder, module .py, .ui, icon files) must all start with capital letter
  • Use Slicer's internationalization infrastructure to add non-English text to the application GUI. To make strings in your extensions translatable in weblate, follow these instructions: https://github.com/Slicer/SlicerLanguagePacks/blob/main/DevelopersManual.md#how-to-make-an-extension-translatable
  • json file fixes needed:
    • "build_subdirectory": incorrect (should be ".")
      "category": choose an existing category
  • CMakeLists.txt fixes needed:
    • EXTENSION_HOMEPAGE incorrect
    • EXTENSION_CATEGORY choose an existing category
    • EXTENSION_ICONURL incorrect
    • EXTENSION_SCREENSHOTURLS incorrect

@lassoan lassoan added the Status: Awaiting Response ⏳ Waiting for a response/more information label Nov 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Awaiting Response ⏳ Waiting for a response/more information
Development

Successfully merging this pull request may close these issues.

2 participants