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 FractionalMyocardialMass extension #1962

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

dmolony3
Copy link

@dmolony3 dmolony3 commented Jul 27, 2023

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 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)
  • 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)

@dmolony3
Copy link
Author

I'm not sure why it is failing the check-filename test. Could someone point me in the right direction to fix this?

@jcfr jcfr changed the title SlicerFractionalMyocardialMass extension Add SlicerFractionalMyocardialMass extension Aug 15, 2023
@jcfr
Copy link
Member

jcfr commented Aug 15, 2023

The error message indicates that the filename SlicerFMM.ext is not expected.

Looking for unexpected files
./SlicerFMM.ext
Looking for unexpected files - failed

Exited with code exit status 1

It should have the extension .s4ext

We will improve the check to report a more explicit error mesage

@jcfr jcfr force-pushed the main branch 2 times, most recently from 32b678b to 729ce43 Compare August 15, 2023 16:43
@jcfr
Copy link
Member

jcfr commented Aug 15, 2023

Additional changes have also been suggested in this pull request:

Summary

  • Update institution associated with David Molony
  • Update extension metadata adding missing screenshot
  • Update module title and category to be more descriptive
  • Rename CMake project from FMM to FractionalMyocardialMass
  • Fix rendering of icon and screenshots using "raw" URLs
  • Remove invalid and redundant description file

@jcfr
Copy link
Member

jcfr commented Aug 15, 2023

@jcfr jcfr added the Status: Awaiting Response ⏳ Waiting for a response/more information label Aug 15, 2023
@jcfr jcfr changed the title Add SlicerFractionalMyocardialMass extension Add FractionalMyocardialMass extension May 2, 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.

None yet

2 participants