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 DiffusionComplexityMap and DTI-ALPS extensions #2013

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

Conversation

acsenrafilho
Copy link
Contributor

@acsenrafilho acsenrafilho commented Mar 13, 2024

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 (This will be made in the near future and placed directly in the Slicer extension wiki page)
    • 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)

@acsenrafilho
Copy link
Contributor Author

Just a quick update: I've added a small video tutorial to present the usage of the DC module, using GUI interface.

Hope that this could be useful for the Slicer community.

Can it be able to be accepted for the Slicer Extension Manager?

@acsenrafilho
Copy link
Contributor Author

Hi Slicers,

I'ver added another new extension in the same PR (hope that's ok).

@jamesobutler could you just check if it's everything ok to be merged?

Any thoughts and suggestions are more than welcome!

Thank you

@jcfr jcfr changed the title ENH: Add new Extension: Diffusion Complexity Map Add DiffusionComplexityMap and DTI-ALPS extensions May 2, 2024
@jcfr jcfr changed the base branch from master to main May 2, 2024 04:55
@jcfr jcfr added the Status: Awaiting Response ⏳ Waiting for a response/more information label May 2, 2024
@acsenrafilho
Copy link
Contributor Author

Hi @jcfr , thank you for the URL adjustments in both modules.
I did not know about the json format as well. I will look more in detail in the documentation to fix this on the next Slicer module proposals.

Would you like me to do anything else to approve this PR?

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