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 SegmentEditorSLIC #1850

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

Add SegmentEditorSLIC #1850

wants to merge 2 commits into from

Conversation

AnnaPSQ
Copy link

@AnnaPSQ AnnaPSQ commented Jun 29, 2022

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.
  • If source code license is more restrictive for users than BSD, MIT, 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)

@jcfr
Copy link
Member

jcfr commented Jul 28, 2022

To improve readability and ensure that the number of completed or remaining tasks is properly reported, in the future, consider using [x] instead of [ x] for checkboxes:

-[ x] Repository name is Slicer+ExtensionName
+[x] Repository name is Slicer+ExtensionName

This will ensure the rendering works as expected:

Before After
image image

This comment was adapted from my GitHub saved replies, it is licensed under a Creative Commons Attribution 4.0 International License and you were welcome to reuse it. Creative Commons License

@jcfr jcfr changed the title SegmentEditorSLIC Add SegmentEditorSLIC Jul 28, 2022
@AnnaPSQ
Copy link
Author

AnnaPSQ commented Aug 9, 2022 via email

@pieper
Copy link
Member

pieper commented Aug 9, 2022

Hi Anna -

The extension becomes part of the nightly extension build and package process once a pull request (PR) like this is merged in this repository. We don't have a formal schedule for reviewing these but there are several people who typically look when their schedule permits. Usually we wait until all the boxes in the checklist are checked to know that a PR is ready for review.

It would be great if you could address the unchecked items and let us know when things are ready to go or if you have any questions. Some I see, like the tutorial, you already have but it's not checked on the list.

Thanks,
Steve

@AnnaPSQ
Copy link
Author

AnnaPSQ commented Aug 10, 2022

Hi Steve,
Thank you very much for your answer. I have now checked all the items ! I'll certainly come back to you with more questions when i update the extension.

Thank you for the time you devote to this project, it's really nice to be able to contribute so easily!

Anna

@jcfr jcfr mentioned this pull request Dec 27, 2022
18 tasks
@jcfr
Copy link
Member

jcfr commented Dec 27, 2022

Reviewing the content of the repository, here are few additional nitpicks that would help users discover and use your extension

  • Remove the PDF and add instructions into a markdown file. This help review and reference the documentation without having to download a file.
  • Update both the extension and the effect icons to be more descriptive (e.g by including the name)
  • Reference sample dataset that the user may download to test the effect.

@lassoan may have useful feedback specific to the proposed editor effect 1

Footnotes

  1. https://github.com/AnnaPSQ/Slicer-SLICSegmentEditorEffect/tree/master/SegmentEditorSlic/SegmentEditorSegmentEditorSlicLib

@jcfr
Copy link
Member

jcfr commented Aug 15, 2023

@AnnaPSQ Did you have a chance to make progress and further improve the documentation ?

@jcfr jcfr added the Status: Awaiting Response ⏳ Waiting for a response/more information label Aug 15, 2023
@jcfr
Copy link
Member

jcfr commented Nov 15, 2023

@AnnaPSQ To move forward, let us know if you have any questions.

@AnnaPSQ
Copy link
Author

AnnaPSQ commented Nov 17, 2023 via email

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

3 participants