Skip to content

Commit

Permalink
Add pull request template
Browse files Browse the repository at this point in the history
  • Loading branch information
lassoan committed Dec 6, 2018
1 parent 15dd260 commit 0ba37e3
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,28 @@
# Update an existing extension

You can delete this whole template and just describe which exension is updated and optionally tell us in a sentence what has been changed.

To make extension updates easier in the future, you may consider replacing specific git hash in your s4ext file by a branch name (for example: `master` or `release` for nightly version; `(majorVersion).(minorVersion)` such as `4.10` for stable Slicer version).

# Submitting a new extension

Thank you very much for considering sharing your extension with the Slicer community.

To make sure users can find your extension, understand what it is intended for and how to use it, please complete the checklist below. You do not need to complete all the item by the time you submit the pull request, but most likely the changes will only be merged if all the tasks are done.

- [ ] 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

See more information about the submission process on the Slicer wiki: https://www.slicer.org/wiki/Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions

If you have any questions or comments then please describe them here.

0 comments on commit 0ba37e3

Please sign in to comment.