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

Adding SlicerIGSIO extension #1593

Merged
merged 1 commit into from
Oct 18, 2018
Merged

Conversation

Sunderlandkyl
Copy link
Member

@pieper
Copy link
Member

pieper commented Oct 17, 2018

I have no idea what IGISO is (and a quick google doesn't seem to help). Could you include a definition or link in the readme?

@Sunderlandkyl
Copy link
Member Author

Right. Added a link to the IGSIO repository and gave an example of some functionality (video IO).

@pieper
Copy link
Member

pieper commented Oct 18, 2018

It's better, but I'd say you should have an explicit link this site, because it's the one that actually explains what is going on: http://igsio.github.io/

@lassoan
Copy link
Contributor

lassoan commented Oct 18, 2018

This is our standard extension checklist:

  • Extension has a reasonable name (not too general, not too narrow, suggests what the extension is for)
  • Repository name is Slicer+ExtensionName
  • Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)
  • Extension URL and revision (scmurl, scmrevision) is correct, consider using a branch name (master, release, …) instead of a specific git has to avoid re-submitting pull request whenever the extension is updated
  • Extension icon URL is correct
  • Screenshot URLs (screenshoturls) are correct, contains at least one
  • Homepage URL points to valid webpage containing the followings:
    • 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 is a utility extension (not to be installed by end users, only to be installed by other extensions), so tutorials, etc. can refer to relevant end-user extensions.

@Sunderlandkyl
Copy link
Member Author

@lassoan Ok, I think it should be more verbose and descriptive now.

status

# One line stating what the module does
description This is a utility extension that is developed as part of is developed as part of the Image Guided Surgery InterOperability (IGSIO) organization (see http://igsio.github.io/), and should be used as a dependency for other extensions (Ex. SlicerIGT) to provide access to tools and algorithms implemented by IGSIO (https://github.com/IGSIO/IGSIO).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description This is a utility extension that is developed as part of is developed as part of the Image Guided Surgery InterOperability (IGSIO) organization (see http://igsio.github.io/), and should be used as a dependency for other extensions (Ex. SlicerIGT) to provide access to tools and algorithms implemented by IGSIO (https://github.com/IGSIO/IGSIO).
description This is a utility extension that is developed as part of the Image Guided Surgery InterOperability (IGSIO) organization (see http://igsio.github.io/), and should be used as a dependency for other extensions (Ex. SlicerIGT) to provide access to tools and algorithms implemented by IGSIO (https://github.com/IGSIO/IGSIO).

@lassoan
Copy link
Contributor

lassoan commented Oct 18, 2018

Thank you, it looks good to me now - except the small type in the extension description. Please also update CMakeLists.txt file to be in sync with the s4ext file.

@Sunderlandkyl
Copy link
Member Author

Sunderlandkyl commented Oct 18, 2018

@lassoan Done, thanks!

@lassoan
Copy link
Contributor

lassoan commented Oct 18, 2018

Thank you! I'll merge this now.

@lassoan lassoan merged commit 59e2951 into Slicer:master Oct 18, 2018
@Sunderlandkyl Sunderlandkyl deleted the slicerigsio branch April 9, 2020 03:20
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.

3 participants