You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+38-10
Original file line number
Diff line number
Diff line change
@@ -6,27 +6,55 @@ Thank you for contributing to 3D Slicer!
6
6
7
7
# New extension
8
8
9
-
<!-- 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. See more information about the submission process here: https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html -->
9
+
<!-- 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. "Tier" of your extension will be determined based on the set of requirements you fulfill. See more information about the submission process here: https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html.
10
+
-->
11
+
12
+
13
+
## Tier 1
14
+
15
+
Any extension that is listed in the Extensions Catalog must fulfill these requirements.
10
16
11
17
-[ ] Extension has a reasonable name (not too general, not too narrow, suggests what the extension is for)
12
-
-[ ] Repository name is Slicer+ExtensionName
18
+
-[ ] Repository name is Slicer+ExtensionName (except if the repository that hosts the extension can be also used without Slicer)
13
19
-[ ] Repository is associated with `3d-slicer-extension` GitHub topic so that it is listed [here](https://github.com/topics/3d-slicer-extension). 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
14
20
-[ ] Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)
15
21
-[ ] Any known related patents must be mentioned in the extension description.
16
-
-[ ] 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.
22
+
-[ ] LICENSE.txt is present in the repository root and the name of the license is mentioned in extension homepage. 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. MIT (https://choosealicense.com/licenses/mit/) or Apache (https://choosealicense.com/licenses/apache-2.0/) license is recommended. Read [here](https://opensource.guide/legal/#which-open-source-license-is-appropriate-for-my-project) to learn more about licenses. If source code license is more restrictive for users than MIT, BSD, Apache, or 3D Slicer license then describe the reason for the license choice and include the name of the used license in the extension description.
17
23
-[ ] 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
18
24
-[ ] 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)
19
25
-[ ] Screenshot URLs (screenshoturls) are correct, contains at least one
20
-
-[ ] Homepage URL points to valid webpage containing the following:
26
+
-[ ] Content of submitted json file is consistent with the top-level CMakeLists.txt file in the repository (dependencies, etc. are the same)
27
+
- Homepage URL points to valid webpage containing the following:
21
28
-[ ] Extension name
22
29
-[ ] Short description: 1-2 sentences, which summarizes what the extension is usable for
23
30
-[ ] At least one nice, informative image, that illustrates what the extension can do. It may be a screenshot.
24
31
-[ ] Description of contained modules: at one sentence for each module
25
-
-[ ] 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
26
32
-[ ] Publication: link to publication and/or to PubMed reference (if available)
27
-
-[ ] 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](https://github.com/Slicer/Slicer/blob/main/License.txt) or the [Apache 2.0](https://www.apache.org/licenses/LICENSE-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](https://opensource.guide/legal/#which-open-source-license-is-appropriate-for-my-project) to learn more about licenses.
28
-
-[ ] Content of submitted json file is consistent with the top-level CMakeLists.txt file in the repository (dependencies, etc. are the same)
29
-
- Hide unused features in the repository to reduce noise/irrelevant information:
30
-
-[ ] Click `Settings` and in repository settings uncheck `Wiki`, `Projects`, and `Discussions` (if they are currently not used)
33
+
- Hide unused github features (such as Wiki, Projects, and Discussions, Releases, Packages) in the repository to reduce noise/irrelevant information:
34
+
-[ ] Click `Settings` and in repository settings uncheck `Wiki`, `Projects`, and `Discussions` (if they are currently not used).
31
35
-[ ] 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)
32
-
<!-- If you have any questions or comments then please describe them here. -->
36
+
- The extension is safe:
37
+
-[ ] Does not include or download binaries from unreliable sources
38
+
-[ ] Does not send any information anywhere without user consent (explicit opt-in is required)
39
+
40
+
## Tier 3
41
+
42
+
Community-supported extensions.
43
+
44
+
-[ ] Documentation, tutorial, and test data are provided for most modules. A tutorial provides step-by-step description of at least the most typical use case, include a few screenshots. Any sample data sets that is used in tutorials must be registered with the Sample Data module to provide easy access to the user.
45
+
-[ ] Follows programming and user interface conventions of 3D Slicer (e.g., GUI and logic are separated, usage of popups is minimized, no unnecessary custom GUI styling, etc.)
46
+
-[ ] Maintainers respond to issues and pull request submitted to the extension's repository.
47
+
-[ ] Maintainers respond to questions directly addressed to him/her via @mention on the [Slicer Forum](https://discourse.slicer.org).
48
+
-[ ] Permissive license is used for the main functions of the extension (recommended Apache or MIT). The extension can provide additional functionality in optional components that are distributed with non-permissive license, but the user has to explicitly approve those before using them (e.g., a pop-up can be displayed that explains the licensing terms and the user has to acknowledge them to proceed).
49
+
- All requirements of tiers < 3.
50
+
51
+
## Tier 5
52
+
53
+
Critically important extensions, supported by Slicer core developers. New Slicer Stable Release is released only if all Tier 5 extension packages are successfully created on all supported platforms.
54
+
55
+
-[ ] Slicer core developers accept the responsibility of fixing any issues caused by Slicer core changes; at least one Slicer core developer (anyone who has commit right to Slicer core) must be granted commit right to the extension's repository.
56
+
-[ ] Automated tests for all critical features.
57
+
-[ ] Maintainers respond to questions related to the extension on the [Slicer Forum](https://discourse.slicer.org).
58
+
- All requirements of tiers < 5.
59
+
60
+
<!-- Feel free to add any questions or comments here. -->
0 commit comments