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/ISSUE_TEMPLATE/presubmission-inquiry.md
+38-9
Original file line number
Diff line number
Diff line change
@@ -14,21 +14,48 @@ Repository Link (if existing):
14
14
15
15
---
16
16
17
+
## Code of Conduct & Commitment to Maintain Package
18
+
19
+
-[ ] I agree to abide by [pyOpenSci's Code of Conduct][PyOpenSciCodeOfConduct] during the review process and in maintaining my package after should it be accepted.
20
+
-[]I have read and will commit to package maintenance after the review as per the [pyOpenSci Policies Guidelines][Commitment].
21
+
17
22
## Description
18
23
19
24
- Include a brief paragraph describing what your package does:
20
25
26
+
## Community Partnerships
27
+
We partner with communities to support peer review with an additional layer of
28
+
checks that satisfy community requirements. If your package fits into an
29
+
existing community please check below:
30
+
31
+
-[ ][Pangeo][pangeoWebsite]
32
+
- [ ] My package adheres to the [Pangeo standards listed in the pyOpenSci peer review guidebook][PangeoCollaboration]
33
+
21
34
## Scope
22
35
23
36
- Please indicate which [category or categories][PackageCategories] this package falls under:
37
+
38
+
## Scope
39
+
- Please indicate which category or categories.
40
+
Check out our [package scope page][PackageCategories] to learn more about our
41
+
scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):
42
+
24
43
- [ ] Data retrieval
25
44
- [ ] Data extraction
26
-
- [ ] Data munging
45
+
- [ ] Data processing/munging
27
46
- [ ] Data deposition
28
-
- [ ] Data visualization
29
-
- [ ] Reproducibility
47
+
- [ ] Data validation and testing
48
+
- [ ] Data visualization **
49
+
- [ ] Workflow automation
50
+
- [ ] Citation management and bibliometrics
51
+
- [ ] Scientific software wrappers
52
+
- [ ] Database interoperability
53
+
54
+
Domain Specific & Community Partnerships
55
+
30
56
- [ ] Geospatial
31
57
- [ ] Education
58
+
- [ ] Pangeo
32
59
- [ ] Unsure/Other (explain below)
33
60
34
61
- Explain how and why the package falls under these categories (briefly, 1-2 sentences). Please note any areas you are unsure of:
@@ -40,17 +67,19 @@ Repository Link (if existing):
40
67
- Any other questions or issues we should be aware of:
41
68
42
69
43
-
-[ ] Please make sure that you took notice of our [Community Code of Conduct][Conduct] and are able to commit to the package maintainance as per our [Policies Guidelines][Commitment].
70
+
**P.S.***Have feedback/comments about our review process? Leave a comment [here][Comments]
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/submit-software-for-review.md
+45-21
Original file line number
Diff line number
Diff line change
@@ -22,23 +22,46 @@ Date accepted (month/day/year): TBD
22
22
23
23
---
24
24
25
+
## Code of Conduct & Commitment to Maintain Package
26
+
27
+
-[ ] I agree to abide by [pyOpenSci's Code of Conduct][PyOpenSciCodeOfConduct] during the review process and in maintaining my package after should it be accepted.
28
+
-[]I have read and will commit to package maintenance after the review as per the [pyOpenSci Policies Guidelines][Commitment].
29
+
25
30
## Description
26
31
27
32
- Include a brief paragraph describing what your package does:
28
33
34
+
29
35
## Scope
30
-
- Please indicate which [category or categories][PackageCategories] this package falls under:
36
+
- Please indicate which category or categories.
37
+
Check out our [package scope page][PackageCategories] to learn more about our
38
+
scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):
39
+
31
40
- [ ] Data retrieval
32
41
- [ ] Data extraction
33
-
- [ ] Data munging
42
+
- [ ] Data processing/munging
34
43
- [ ] Data deposition
35
-
- [ ] Reproducibility
44
+
- [ ] Data validation and testing
45
+
- [ ] Data visualization **
46
+
- [ ] Workflow automation
47
+
- [ ] Citation management and bibliometrics
48
+
- [ ] Scientific software wrappers
49
+
- [ ] Database interoperability
50
+
51
+
Domain Specific & Community Partnerships
52
+
36
53
- [ ] Geospatial
37
54
- [ ] Education
38
-
- [ ] Data visualization*
55
+
- [ ] Pangeo
56
+
39
57
40
-
> *Please fill out a pre-submission inquiry before submitting a data visualization package. For more info, see [notes on categories][NotesOnCategories] of our guidebook.*
58
+
## Community Partnerships
59
+
If your package is associated with an
60
+
existing community please check below:
61
+
-[ ][Pangeo][pangeoWebsite]
62
+
- [ ] My package adheres to the [Pangeo standards listed in the pyOpenSci peer review guidebook][PangeoCollaboration]
41
63
64
+
> ** Please fill out a pre-submission inquiry before submitting a data visualization package.*
42
65
43
66
-**For all submissions**, explain how the and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):
44
67
@@ -50,17 +73,17 @@ Date accepted (month/day/year): TBD
50
73
51
74
## Technical checks
52
75
53
-
For details about the pyOpenSci packaging requirements, see our [packaging guide][PackagingGuide]. Confirm each of the following by checking the box. This package:
76
+
For details about the pyOpenSci packaging requirements, see our [packaging guide][PackagingGuide]. Confirm each of the following by checking the box. This package:
54
77
55
78
-[ ] does not violate the Terms of Service of any service it interacts with.
56
-
-[ ]has an [OSI approved license][OsiApprovedLicense].
79
+
-[ ]uses an [OSI approved license][OsiApprovedLicense].
57
80
-[ ] contains a README with instructions for installing the development version.
58
81
-[ ] includes documentation with examples for all functions.
59
-
-[ ] contains a vignette with examples of its essential functions and uses.
82
+
-[ ] contains a tutorial with examples of its essential functions and uses.
60
83
-[ ] has a test suite.
61
-
-[ ] has continuous integration, such as Travis CI, AppVeyor, CircleCI, and/or others.
84
+
-[ ] has continuous integration setup, such as GitHub Actions CircleCI, and/or others.
62
85
63
-
## Publication options
86
+
## Publication Options
64
87
65
88
-[ ] Do you wish to automatically submit to the [Journal of Open Source Software][JournalOfOpenSourceSoftware]? If so:
66
89
@@ -81,9 +104,10 @@ This option will allow reviewers to open smaller issues that can then be linked
81
104
82
105
-[x] Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.
83
106
84
-
## Code of conduct
107
+
Confirm each of the following by checking the box.
85
108
86
-
-[ ] I agree to abide by [pyOpenSci's Code of Conduct][PyOpenSciCodeOfConduct] during the review process and in maintaining my package should it be accepted.
109
+
-[ ] I have read the [author guide](https://www.pyopensci.org/software-peer-review/how-to/author-guide.html).
110
+
-[ ] I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed.
87
111
88
112
## Please fill out our survey
89
113
-[ ][Last but not least please fill out our pre-review survey](https://forms.gle/F9mou7S3jhe8DMJ16). This helps us track
@@ -98,25 +122,25 @@ The [editor template can be found here][Editor Template].
98
122
99
123
The [review template can be found here][Review Template].
0 commit comments