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/help-request.md
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@ assignees: ''
9
9
10
10
## What is this?
11
11
12
-
To make the review process easier and to help you maintain your package, pyOpenSci requires testing, continuous integration, and full documentation for packages submitted for review (read more [here](https://www.pyopensci.org/dev_guide/packaging/packaging_guide.html#overview). We want to make this as easy as possible for newcomers, so if you'd like some help in prepping your package you can submit this request and we'll assign someone to help you out!
12
+
To make the review process easier and to help you maintain your package, pyOpenSci requires testing, continuous integration, and full documentation for packages submitted for review (read more [here][PackagingGuide]. We want to make this as easy as possible for newcomers, so if you'd like some help in prepping your package you can submit this request and we'll assign someone to help you out!
13
13
14
-
Before submitting a request, check out our [Packaging Guide](https://www.pyopensci.org/dev_guide/packaging/packaging_guide.html). The answers to your questions might be there already.
14
+
Before submitting a request, check out our [Packaging Guide][PackagingGuide]. The answers to your questions might be there already.
15
15
16
16
17
17
## Package Info
@@ -26,7 +26,7 @@ Repository Link (if existing):
26
26
27
27
```
28
28
29
-
- Please indicate which [category or categories](https://pyopensci.github.io/dev_guide/peer_review/peer_review_proc.html#aims-and-scope) this package falls under:
29
+
- Please indicate which [category or categories][PackageCatagories] this package falls under:
30
30
- [ ] Data retrieval
31
31
- [ ] Data extraction
32
32
- [ ] Data munging
@@ -54,5 +54,11 @@ Repository Link (if existing):
54
54
- Any other questions or issues we should be aware of?:
55
55
56
56
57
+
**P.S.***Have feedback/comments about our review process? Leave a comment [here][Comments]
57
58
58
-
**P.S.***Have feedback/comments about our review process? Leave a comment [here](https://github.com/pyOpenSci/governance/issues/8)*
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/presubmission-inquiry.md
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Repository Link (if existing):
20
20
21
21
## Scope
22
22
23
-
- Please indicate which [category or categories](https://pyopensci.github.io/dev_guide/peer_review/peer_review_proc.html#aims-and-scope) this package falls under:
23
+
- Please indicate which [category or categories][PackageCatagories] this package falls under:
24
24
- [ ] Data retrieval
25
25
- [ ] Data extraction
26
26
- [ ] Data munging
@@ -41,4 +41,9 @@ Repository Link (if existing):
41
41
42
42
43
43
44
-
**P.S.***Have feedback/comments about our review process? Leave a comment [here](https://github.com/pyOpenSci/governance/issues/8)*
44
+
**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
+34-11Lines changed: 34 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Version accepted: TBD
25
25
- Include a brief paragraph describing what your package does:
26
26
27
27
## Scope
28
-
- Please indicate which [category or categories](https://www.pyopensci.org/dev_guide/peer_review/aims_scope.html) this package falls under:
28
+
- Please indicate which [category or categories][PackageCatagories] this package falls under:
29
29
- [ ] Data retrieval
30
30
- [ ] Data extraction
31
31
- [ ] Data munging
@@ -35,7 +35,7 @@ Version accepted: TBD
35
35
- [ ] Education
36
36
- [ ] Data visualization*
37
37
38
-
\* Please fill out a pre-submission inquiry before submitting a data visualization package. For more info, see [this section](https://www.pyopensci.org/dev_guide/peer_review/aims_scope.html#notes-on-categories) of our guidebook.
38
+
\* Please fill out a pre-submission inquiry before submitting a data visualization package. For more info, see [notes on categories][NotesOnCategories] of our guidebook.
39
39
40
40
- Explain how the and why the package falls under these categories (briefly, 1-2 sentences):
41
41
@@ -47,10 +47,10 @@ Version accepted: TBD
47
47
48
48
## Technical checks
49
49
50
-
For details about the pyOpenSci packaging requirements, see our [packaging guide](https://www.pyopensci.org/dev_guide/packaging/packaging_guide.html). Confirm each of the following by checking the box. This package:
50
+
For details about the pyOpenSci packaging requirements, see our [packaging guide][PackagingGuide]. Confirm each of the following by checking the box. This package:
51
51
52
52
-[ ] does not violate the Terms of Service of any service it interacts with.
53
-
-[ ] has an [OSI approved license](https://opensource.org/licenses)
53
+
-[ ] has an [OSI approved license][OsiApprovedLicense].
54
54
-[ ] contains a README with instructions for installing the development version.
55
55
-[ ] includes documentation with examples for all functions.
56
56
-[ ] contains a vignette with examples of its essential functions and uses.
@@ -59,14 +59,14 @@ For details about the pyOpenSci packaging requirements, see our [packaging guide
59
59
60
60
## Publication options
61
61
62
-
-[ ] Do you wish to automatically submit to the [Journal of Open Source Software](http://joss.theoj.org/)? If so:
62
+
-[ ] Do you wish to automatically submit to the [Journal of Open Source Software][JournalOfOpenSourceSoftware]? If so:
63
63
64
64
<details>
65
65
<summary>JOSS Checks</summary>
66
66
67
-
-[ ] The package has an **obvious research application** according to JOSS's definition in their [submission requirements](https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements). Be aware that completing the pyOpenSci review process **does not** guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS.
68
-
-[ ] The package is not a "minor utility" as defined by JOSS's [submission requirements](https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements): "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria.
69
-
-[ ] The package contains a `paper.md` matching [JOSS's requirements](https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain) with a high-level description in the package root or in `inst/`.
67
+
-[ ] The package has an **obvious research application** according to JOSS's definition in their [submission requirements][JossSubmissionRequirements]. Be aware that completing the pyOpenSci review process **does not** guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS.
68
+
-[ ] The package is not a "minor utility" as defined by JOSS's [submission requirements][JossSubmissionRequirements]: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria.
69
+
-[ ] The package contains a `paper.md` matching [JOSS's requirements][JossPaperRequirements] with a high-level description in the package root or in `inst/`.
70
70
-[ ] The package is deposited in a long-term repository with the DOI:
71
71
72
72
*Note: Do not submit your package separately to JOSS*
@@ -80,11 +80,34 @@ This option will allow reviewers to open smaller issues that can then be linked
80
80
81
81
## Code of conduct
82
82
83
-
-[ ] I agree to abide by [pyOpenSci's Code of Conduct](https://www.pyopensci.org/contributing-guide/peer_review/coc.html) during the review process and in maintaining my package should it be accepted.
83
+
-[ ] I agree to abide by [pyOpenSci's Code of Conduct][PyOpenSciCodeOfConduct] during the review process and in maintaining my package should it be accepted.
84
84
85
85
86
-
**P.S.***Have feedback/comments about our review process? Leave a comment [here](https://github.com/pyOpenSci/governance/issues/8)*
86
+
**P.S.***Have feedback/comments about our review process? Leave a comment [here][Comments]
87
87
88
88
## Editor and Review Templates
89
89
90
-
[Editor and review templates can be found here](https://www.pyopensci.org/contributing-guide/appendices/templates.html)
90
+
[Editor and review templates can be found here][Templates]
This repo hosts the pyOpenSci review process. Packages contributed to pyOpenSci undergo an open peer-review by community reviewers.
3
+
This repo hosts the pyOpenSci review process. Packages contributed to pyOpenSci undergo an open peer-review by community reviewers.
4
4
5
-
If you are interested in submitting a package, check out our [guidebook](https://www.pyopensci.org/dev_guide/intro.html) for info about how to package your code and submit a request for review. For authors, the most important sections are the [scope of pyOpenSci](https://www.pyopensci.org/dev_guide/peer_review/aims_scope.html), the [author guide](https://www.pyopensci.org/dev_guide/peer_review/author_guide.html), and the [packaging guide](https://www.pyopensci.org/dev_guide/packaging/packaging_guide.html). For details about the exact timeline and process of peer-review, see [this section](https://www.pyopensci.org/dev_guide/peer_review/peer_review_proc.html).
5
+
If you are interested in submitting a package, check out our [guidebook][Guidebook] for info about how to package your code and submit a request for review. For authors, the most important sections are the [scope of pyOpenSci][Scope], the [author guide][AuthorGuide], and the [
6
+
packaging guide][PackagingGuide]. For details about the exact timeline and process of peer-review, see [peer review timeline][PeerReviewTimeline].
6
7
7
-
When you are ready to submit for review, fill out the [Submission template](https://github.com/pyOpenSci/software-review/issues/new?assignees=&labels=&template=submit-software-for-review.md&title=).
8
+
When you are ready to submit for review, fill out the [Submission template][SubmissionTemplate]
9
+
.
8
10
9
-
If your package is not yet fully-developed or you're not sure whether it fits within pyOpenSci's [scope](https://www.pyopensci.org/dev_guide/peer_review/aims_scope.html), you can create a [presubmission inquiry issue](https://github.com/pyOpenSci/software-review/issues/new?assignees=&labels=&template=presubmission-inquiry.md&title=).
11
+
If your package is not yet fully-developed or you're not sure whether it fits within pyOpenSci's [
12
+
scope][Scope], you can create a [presubmission inquiry issue][PresubmissionInquiryIssue].
0 commit comments