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
-[ ]**Fit**: The package meets criteria for [fit](https://www.pyopensci.org/peer-review-guide/about-peer-review/aims-and-scope.html#package-scope) and [overlap](https://www.pyopensci.org/peer-review-guide/about-peer-review/aims-and-scope.html#package-overlap).
2
+
-[ ]**Package overlap:** That package doesn't fully overlap with functionality of other packages that have already been submitted to pyOpenSci
2
3
-[ ]**Documentation** The package has sufficient documentation available online (README, sphinx docs) to allow us to evaluate package function and scope *without installing the package*. This includes:
3
4
-[ ] Get started vignettes or tutorials that help a user understand how to use the package and what it can do for them
4
5
-[ ] API documentation - this includes clearly written doc strings with variables defined using a standard docstring format
@@ -9,7 +10,4 @@
9
10
-[ ]**License:** The package has an OSI accepted license
10
11
-[ ]**Repository:** The repository link resolves correctly
11
12
-[ ]**README:** The package has a README with clear explanation of what the packages does and instructions on how to install it along with development instructions.
12
-
-[ ]**Contributing statement:** The package has a `contributing.md` file that details how to contribute to the package.
13
-
-[ ]**Package overlap:** That package doesn't fully overlap with functionality of other packages that have already been submitted to pyOpenSci
14
-
-[ ]**Archive** (JOSS only, may be post-review): The repository DOI resolves correctly
15
-
-[ ]**Version** (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?
13
+
-[ ]**Contributing statement:** The package has a `contributing.md` file that details how to contribute to the package.
# pyOpenSci Review Guide for Python Open Source Package Maintainers and Authors
2
2
3
3
Are you considering submitting a package for review with pyOpenSci? You've
4
-
come to the right place!
5
-
6
-
Below you will find the steps that you need to follow to submit a package
4
+
come to the right place! Below you will find the steps that you need to follow to submit a package
7
5
to pyOpenSci for peer review.
8
6
9
7
Before you begin this process, [please be sure to read the review process guidelines](../about-peer-review/policies-guidelines).
10
8
9
+
10
+
```{note}
11
+
**Before you consider submitting to us please consider the following:**
12
+
13
+
1. Please be sure that you have time to devote to making changes to your
14
+
package. You may get feedback from an editor and two reviewers. Changes could
15
+
take time. Please consider this before submitting to us. You can read more about the timeline to make changes in our [peer review policies page](../about-peer-review/policies-guidelines).
16
+
2. Peer review is lead by a diverse group of volunteer editors and reviewers.
17
+
Please be considerate when engaging with everyone online.
18
+
```
19
+
11
20
## 1. Do you plan to continue to maintain your package?
12
21
One of the goals of pyOpenSci is to maintain a curated list of
13
22
community-approved, maintained and vetted tools that support open science workflows.
14
23
15
-
As such we review packages that will be useful to the community
24
+
As such, we review packages that will be useful to the community
16
25
and maintained over time. While we understand that burnout is real,
17
26
and you may move on in the future to other projects, we ask that you commit
18
-
to maintaining your package for at least 1-2 years.
27
+
to maintaining your package for at least 1-2 years after the review process
28
+
is complete.
19
29
20
30
If that maintenance commitment is too much, you might consider submitting
21
-
your package to another Journal.
31
+
your package to a Journal that is more focused on publication only.
22
32
23
-
If you need to step from maintaining your package, please let us know
24
-
in advance. We will try to help you either.
25
-
26
-
* Find a new maintainer to take over your project or
27
-
* Sunset your package.
28
33
29
-
If the package is sunsetted we will remove it from our curated list
30
-
of vetted tools.
31
34
32
35
### Who should submit the package for review?
33
36
34
37
If you have a team of people maintaining your package, please be sure
35
-
that the submitting author is the person who "owns" or leads that maintenance. That person will become the long term point of contact
36
-
for pyOpenSci.
38
+
that the submitting author is the person who "owns" or leads that maintenance.
39
+
That person will become the long term point of contact
40
+
for pyOpenSci.
41
+
* Please also include the names of all maintainers on the project
42
+
as we also want to ensure that everyone working on the project gets full credit
43
+
for their effort.
44
+
37
45
38
46
```{note}
39
47
If your package is more of a tool to support a specific workflow that
40
-
either may not be maintained long term or that may be so specific that
41
-
it won't have a broad user base, you might consider submitting it
42
-
directly to the Journal of Open Source Software (JOSS).
48
+
either:
49
+
* may not be maintained long term or
50
+
* that may be so specific that it won't have a user base outside of your lab or work environment,
51
+
52
+
please consider submitting it directly to a publisher like the
53
+
Journal of Open Source Software (JOSS). A publisher like JOSS has less
54
+
emphasis on long term software maintenance and focuses more on
55
+
publication quality and citation / credit.
43
56
```
44
57
45
58
46
59
## 2. Does Your Package Meet Packaging Requirements?
47
60
Before submitting your project for review with pyOpenSci, make sure that it
48
61
follows the standards and guidelines outlined in the
**Package Prep Help - Can we actually support this now??**
53
66
54
67
If you would like help preparing your package for review, create
55
-
a [Help Request issue](https://github.com/pyOpenSci/software-review/issues/new/choose)
56
-
in the software-review repo. We can assign someone to help you prep your code
57
-
and add things like testing, documentation, and/or continuous integration. We're
58
-
happy to help. Also check out the rest of our [Packaging Guide](../authoring/overview), which may help answer some of your questions about packaging your code.
68
+
a [new help request post in our Discourse forum under `coding-help`](https://pyopensci.discourse.group/c/coding-help/10). We can find someone to help you prep your code
69
+
and add things like testing, documentation, and/or continuous integration.
70
+
71
+
Also check out the rest of our [Packaging Guide](https://www.pyopensci.org/python-package-guide), which may help answer some of your questions about packaging your code.
72
+
73
+
**NOTE: we are currently updating our packaging guide and intend to add
74
+
tutorials on python packaging. Please expect these resources to be online sometime by Spring, 2023.**
59
75
```
60
76
61
77
## 3. Is Your Package in Scope for pyOpenSci?
62
-
Next, check to see if your package falls into the scope of pyOpenSci. If you aren't
78
+
Next, check to see if your package falls into the topical and technical scope of pyOpenSci. If you aren't
63
79
sure about whether your package fits within pyOpenSci's scope (below), submit
64
80
a [presubmission inquiry issue on the software-review](https://github.com/pyOpenSci/software-review/issues/new?assignees=&labels=0%2Fpresubmission&template=presubmission-inquiry.md&title=)
65
81
repository. After you submit an inquiry, a pyOpenSci editor will get back to you
66
82
with input regarding the fit of your package for pyOpenSci review. This can take
67
83
up to a week.
68
84
69
-
```{include} ../scope.md
70
-
```
85
+
Our current categories for determining package scope are below:
71
86
72
-
```{note}
73
-
**Before you consider submitting to us please consider the following:**
74
-
75
-
1. Please be sure that you have time to devote to making changes to your
76
-
package. You may get feedback from an editor and two reviewers. Changes could
77
-
take time. Please consider this before submitting to us. You can read more about the timeline to make changes in our [peer review policies page](../about-peer-review/policies-guidelines).
78
-
2. Peer review is lead by a diverse group of volunteer editors and reviewers.
79
-
Please be considerate when engaging with everyone online.
87
+
```{include} ../scope.md
80
88
```
81
89
82
-
## 4. Presubmission Questions
83
-
84
-
If your package does not clearly fit within one of the categories outlined in
a [Presubmission Inquiry issue](https://github.com/pyOpenSci/software-review/issues/new?assignees=&labels=0%2Fpresubmission&template=presubmission-inquiry.md&title=)
87
-
in our software-review repo. You can use the same issue template if you have
88
-
other questions. An editor will get back to you in a few days to answer your
89
-
questions and to help determine the fit.
90
-
91
-
## 5. Submit Your Package for Peer Review
90
+
## 4. Submit Your Package for Peer Review
92
91
To submit your package for peer review, you can
93
92
open an issue in our [pyopensci/software-review repo](https://github.com/pyOpenSci/software-review/issues/new/choose/)
94
93
repository and fill out the [Submit Software for Review](https://github.com/pyOpenSci/software-review/issues/new?assignees=&labels=1%2Feditor-checks%2C+New+Submission%21&template=submit-software-for-review.md&title=) issue template.
95
94
96
-
## 6. Editor in Chief Reviews Package for Scope and Minimal Infrastructure Criteria
97
-
Once the issue is opened, an editor will review your submission within
95
+
## 5. Editor in Chief Reviews Package for Scope and Minimal Infrastructure Criteria
96
+
Once the issue is opened, our editor-in-chief and an editor from our editorial board will review your submission within
98
97
**2 weeks** and respond with next steps. The editor may request that you make updates
99
98
to your package to meet minimal criteria before review. They also may reject your
100
99
package if it does not fall within our scope.
101
100
102
-
## 7. The Review Begins
101
+
## 6. The Review Begins
103
102
If your package meets minimal criteria for being
104
103
reviewed it may then be given to an editor with appropriate domain experience
105
104
to run the review. That editor will assign 2-3 reviewers to review your
@@ -108,13 +107,14 @@ issue within **3 weeks**. Reviewers also can open issues in your package reposit
108
107
We prefer issues that link back to the review as they document changes made to your
109
108
package that were triggered by our review process.
110
109
111
-
## 8. Response to Reviews
110
+
## 7. Response to Reviews
112
111
You should respond to reviewers’ comments within **2 weeks** of the
113
112
last-submitted review. You can make updates to your package at any time. We
114
113
encourage ongoing conversations between authors and reviewers. See the
115
-
reviewing guide for more details.
114
+
[guide for package reviewers](reviewer-guide.md) for more details about how reviewers engage with package
115
+
maintainers during a review.
116
116
117
-
## 9. Acceptance into pyOpenSci
117
+
## 8. Acceptance into pyOpenSci
118
118
Once the reviewers are happy with changes that you've made to the package, the
119
119
editor will review everything and accept your package into the pyOpenSci ecosystem.
120
120
Congratulations! You are almost done!
@@ -128,13 +128,15 @@ Once your package is approved, a few things will happen:
128
128
Zenodo. You will then want to created a tagged release representing the version of the
129
129
package accepted by pyOpenSci.
130
130
2 We will ask you to add the pyOpenSci badge [](https://github.com/pyOpenSci/software-review/issues/issue-number) to the
131
-
top of your README.md file.
131
+
top of your **README.md** file.
132
132
1. We will ask you to add your package to the [pyOpenSci website](https://www.pyopensci.org/our-community/). This will give
133
133
your package more visibility in the community as a vetted pyOpenSci tool.
134
-
* We also will ask you (and those who reviewed your package) to add yourself to our list of contributors as a maintainer!
135
-
1. We will promote your package on our twitter channel!
136
-
2. If you wish to go on to submit your package to JOSS, this is when you'd start
137
-
that process.
134
+
* We also will ask you (and those who reviewed your package) to add yourself to our list of [pyOpenSci community members](https://www.pyopensci.org/our-community/)!
135
+
1. We will promote your package on our social media channels!
136
+
1. We will invite you to write a blog on our website spotlighting your package. The blogs that our maintainers write are some of the most popular content on the website!
137
+
138
+
139
+
If you wish to go on to submit your package to JOSS, you can do so now. Remember that JOSS will accept our review as theirs so you DO NOT need to go through another review. Read more below.
138
140
139
141
### Journal of Open Source Software (JOSS) Submission
140
142
@@ -148,10 +150,9 @@ will evaluated by JOSS through the pyOpenSci review
148
150
file describing the package following JOSS' standards (see below). More detail on the requirements for JOSS can be found on [their website](https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain).
149
151
- If you choose to opt into the pyOpenSci / JOSS partnership in your review,
150
152
you do NOT need to go through a second review with JOSS. JOSS accepts our review
151
-
for theirs. Please just start a review process with JOSS and reference the pyOpenSci
152
-
review issue that you have been working within for your review with us. Make sure
153
-
that you let the JOSS editor know that we have already accepted you. They will use
154
-
our review for their process and fast track you through their review!
153
+
for theirs. Please start a review process with JOSS and reference the pyOpenSci
154
+
review issue where your package was accepted. Make sure
155
+
that you let the JOSS editor know that we have already accepted your package. The JOSS editor will review your paper and once that is accepted you now have a JOSS DOI and badge to display on your README file as well!
155
156
156
157
```{note}
157
158
Acceptance to pyOpenSci does not guarantee acceptance to JOSS. In particular,
@@ -162,3 +163,24 @@ are usually not accepted by JOSS. Be sure to review JOSS's
Once you have been accepted into the pyOpenSci ecosystem, you will
170
+
be invited to join our Slack channel.
171
+
172
+
We also will keep in touch with you, periodically checking in to ensure that package maintenance is going well and to better understand ways in which pyOpenSci can support you.
173
+
174
+
If at any time, you need to step from maintaining your package,
175
+
or you need help with maintenance, please let us know - preferably
176
+
in advance. We will try to help you either.
177
+
178
+
* Find a new maintainer to take over your project (or additional maintainers to support maintenance) or
179
+
* Sunset your package.
180
+
181
+
If the package is sunsetted we will remove it from our curated list
182
+
of vetted tools.
183
+
184
+
### Communication with pyOpenSci and removing tools from our vetted tool list
185
+
186
+
To ensure packages that we support and advocate for are maintained, if your package is accepted and we are not able to get in touch with you through normal communication channels (GitHub, email) after reaching our for atleast 1-2 months, we will remove your package from our list of vetted tools. We will also sunset any blogs written that highlight your tool.
0 commit comments