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

Add MONAIViz extension #1917

Merged
merged 2 commits into from
Aug 15, 2023
Merged

Add MONAIViz extension #1917

merged 2 commits into from
Aug 15, 2023

Conversation

lassoan
Copy link
Contributor

@lassoan lassoan commented Feb 25, 2023

  • 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 has 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 s4ext file is consistent with the top-level CMakeLists.txt file in the repository (description, URLs, dependencies, etc. are the same)

@SachidanandAlle
Copy link
Contributor

Following can be checked

Repository is associated with 3d-slicer-extension
Extension description summarizes in 1-2 sentences
Screenshot URLs (screenshoturls) are correct

No Patent related things applicable

@lassoan
Copy link
Contributor Author

lassoan commented Feb 26, 2023

Almost complete (just need to merge PRs):

The main missing task to make this extension readily usable is a short tutorial. It does not have to be anything fancy. It is just a bullet-point list of one simple, typical scenario that shows one example how the module can be used. For example: load ... sample data set, choose ... bundle, select the image, ... what to click to run, edit parameters, re-run, etc.

@pieper
Copy link
Member

pieper commented Feb 26, 2023

The main missing task to make this extension readily usable is a short tutorial.

Agreed - I was able to basically figure it out with some clicking around and looking at screenshots, but it would really have helped to have a tutorial to get people going.

@SachidanandAlle
Copy link
Contributor

anything pending on this PR?

@jcfr jcfr changed the title Create MONAIViz.s4ext Add MONAIViz extension Aug 15, 2023
@jcfr jcfr merged commit e5c2466 into main Aug 15, 2023
@jcfr jcfr deleted the add-MONAIViz branch August 15, 2023 23:05
@jcfr
Copy link
Member

jcfr commented Aug 15, 2023

For reference, the following pull request was submitted:

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.

4 participants