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 SlicerTractParcellation extension #2037

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

Conversation

zhangfanmark
Copy link

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

@pieper
Copy link
Member

pieper commented Apr 19, 2024

@zhangfanmark thanks for putting this together. Please do go through the checklist in this template and perform the steps. It may seem like a lot but they should be quick for either you or Kening to do. Things like including some screenshots and descriptive text to form a tutorial will really help anyone who wants to use your tutorial. Also adding the 3d-slicer-extension will make it easier for people to find. Plus it will show off your work!

@zhangfanmark
Copy link
Author

Hi @pieper Kening is working on the checklist and he will do a pull request later. Thank you!!!

@pieper
Copy link
Member

pieper commented Apr 27, 2024

Thanks Fan 👍 If Kening has any questions at all, let us know.

@JoshuaKening
Copy link

@pieper We have accomplished the extension, https://github.com/SlicerDMRI/SlicerTractParcellation, here is the link. Please let me know if there are any imperfections. And do we need to create a new pull request to refresh the version?

@pieper
Copy link
Member

pieper commented May 1, 2024

Hi Kening - The license is good and the image looks nice so thanks for the update.

What we were looking for is the items on the checklist at the top of this page, e.g. going through point by point and ensuring that the listed items have been taken into account.

For example, the first unchecked box is "Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)". While there is a sentence in the README, I'm not sure it's appropriate yet, since very few people would know what WMA or ORG are. Here it would be nicer to spell out the terms "White Matter Analysis" and "O'Donnell Research Group" and include links to places where they can get more information.

Another point is that the URLs in the CMakeLists file haven't been updates. For example, this line still has the placeholder example.com in the path, which is clearly not the path to the screenshots.

You can have a look at other extensions to see how they have addressed the checklist items. Here's a recent example that is nicely done: SlicerMONAIAuto3DSeg. It has a nice description and several images that give a clear idea what the extension does. It also has valid URLs and other content.

You don't need a new pull request, just update your site and edit the checklist above as you confirm that each of the topics has been addressed.

I hope it's clear why we ask developers to follow this template so that users can discover and understand your contributions.

Best,
Steve

@JoshuaKening @zhangfanmark @ljod

Also update category from "Libraries" to "Diffusion"
@jcfr jcfr force-pushed the SlicerTractParcellation branch from b2396cf to 1d11e97 Compare May 1, 2024 22:00
@jcfr jcfr changed the title add SlicerTractParcellation.s4ext Add SlicerTractParcellation extension May 2, 2024
@jcfr jcfr added the Status: Awaiting Response ⏳ Waiting for a response/more information label 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

4 participants