Skip to content

Commit cbdbefc

Browse files
committed
Add: holding language to editor guide and other edigs
1 parent b4ff369 commit cbdbefc

File tree

5 files changed

+66
-26
lines changed

5 files changed

+66
-26
lines changed

about-peer-review/how-peer-review-works.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,12 @@ We use GitHub because:
4242
* We label issues to track every step of the package submission and review progress (e.g. [1/initial-editor-checks, 2/reviewers-needed, 6/pyopensci-approved](https://github.com/pyOpenSci/software-review/labels)
4343

4444
```{note}
45-
Click [here](https://github.com/ropensci/software-review/issues/24) to read the review thread from an rOpenSci review of the `ropenaq` package. Note that the process is an ongoing conversation until the package is accepted. Two external reviews are important milestones in the review process.
45+
[Click here to read the review thread from a December 2022
46+
pyOpenSci pre-submission issue.](https://github.com/pyOpenSci/software-review/issues/65) Note the conversational
47+
tone of the pre-review. In this case the package was improved
48+
Before the formal review even began.
49+
50+
In the actual review process, two external reviews are important milestones. The editor will also provide the author with some feedback.
4651
```
4752

4853
For more detailed overview of the peer review process, [check out our process

about-peer-review/policies-guidelines.md

+19-25
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,25 @@
22

33
## Review Process Guidelines
44

5-
- Packages are reviewed for quality, fit, documentation, clarity and the review process
6-
is quite similar to a manuscript review (see our [packaging guide](../authoring/overview)
7-
and [reviewing guide](../peer-review-guides/reviewer-guide) for more details). Unlike a
8-
manuscript review, this process will be an ongoing conversation.
9-
- Once all major issues and questions, and those addressable with reasonable effort, are
10-
resolved, the editor assigned to a package will make a decision (accept, hold, or
11-
reject). Rejections are usually done early (before the review process begins, see the
12-
aims and scope section). In rare cases a package may also not be on-boarded after
13-
review & revision. It is ultimately editor’s decision on whether or not to reject the
14-
package based on how the reviews are addressed.
15-
- Communication between authors, reviewers and editors will first and foremost take
16-
place on GitHub, although you can choose to contact the editor by email. When
17-
submitting a package, please make sure your GitHub notification settings make it
18-
unlikely you will miss a comment.
19-
- The author can choose to have their submission put on hold (editor applies the holding
20-
label). The holding status will be revisited every 3 months, and after one year the
21-
issue will be closed.
22-
- If the author hasn’t requested a holding label, but is simply not responding, we
23-
should close the issue within one month after the last contact intent. This intent
24-
will include a comment tagging the author, but also an email using the email address
25-
listed in the DESCRIPTION of the package which is one of the rare cases where the
26-
editor will try to contact the author by email.
27-
- If a submission is closed and the author wishes to re-submit, they’ll have to start a
28-
new submission. If the package is still in scope, the author will have to respond to
29-
the initial reviews before the editor starts looking for new reviewers.
5+
pyOpenSci packages are reviewed for quality, fit, scope,
6+
documentation and usability. The review process
7+
is similar to a manuscript review, however it has a stronger
8+
focus on Python packaging best practices.
9+
10+
Unlike a manuscript review, our peer review process is be an ongoing conversation. Once all major issues and questions are addressed, the review editor package will make a decision to accept, hold, or reject the package.
11+
12+
Rejections are usually done early in the process, before the review process begins. In rare cases a package may also not be on-boarded into the pyOpenSci ecosystem after review & revision.
13+
14+
It is ultimately editor’s decision on whether or not to reject the package based on how the reviews are addressed.
15+
16+
## Review communication approach
17+
18+
Communication between authors, reviewers and editors takes
19+
place on GitHub. You can, however choose to contact the editor by email if needed.
20+
21+
When submitting a package, please make sure that your GitHub notification settings are setup to notify you when you receive feedback on the review issue.
22+
23+
3024

3125
## Submitting your package for review in other venues
3226

appendices/editor-in-chief-checks.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ review. Below are the basic checks that your package needs to pass
66
to begin our review. If some of these are missing, we will ask you
77
to work on them before the review process begins.
88

9+
- [ ] **Installation** The package can be installed from a community repository such as PyPI (preferred), and/or a community channel on conda (e.g. conda-forge, bioconda)
10+
- [ ] The package imports properly into a standard Python environment `import package-name`
911
- [ ] **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).
1012
- [ ] **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:
1113
- [ ] Short tutorials or [vignettes](https://kbroman.org/pkg_primer/pages/vignettes.html) that help a user understand how to use the package and what it can do for them (often these have a name like "Getting started")

software-peer-review-guide/editor-in-chief-guide.md

+11
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,17 @@ When a new package is submitted for review, the Editor in Chief will:
4444

4545
### 2. ✔️ Add the editor checks to the issue
4646

47+
```{important}
48+
It is important that this step occur in one post rather than a string of
49+
conversational feedback that is more difficult to follow. This allows the author to address all issues at
50+
one time. Thus the EIC should:
51+
52+
1. Review the checklist
53+
1. Give the author a rough estimate of how long the checks might take to complete
54+
1. Perform all of the checks locally
55+
1. When all of the above are complete, post the checklist with any feedback for the author in the issue. This should be one single post.
56+
```
57+
4758
Copy the {ref}`template below <editor-checklist-template>`
4859
and add it to the issue.
4960

software-peer-review-guide/editors-guide.md

+28
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,34 @@ Be sure to:
239239
review next time (e.g. a package author who has already submitted packages to us).
240240
```
241241

242+
## Putting a review on hold & handling non-responsive authors
243+
244+
In some cases, an author may need more time to respond to
245+
review comments. In this case, the author can choose to have
246+
their submission put on hold. As an editor you should apply the `holding label` to the GitHub issue.
247+
248+
The holding status will be revisited every 3 months.
249+
250+
After one year the issue will be closed if there is no movement towards responding to reviews by the author.
251+
252+
If the author simply not responding, the editor should:
253+
254+
* Tag the author (`@author-github-handle`) in an issue comment notifying them that we will close ths issue in one month if there is no response.
255+
* Close the issue if one month has passed without a reply.
256+
257+
If needed you can also chose to email the author. using the email provided in the package metadata file of the package. The email
258+
could be in any of the three files in the package: `setup.py`, `pyproject.toml` (preferred) or `setup.cfg`.
259+
260+
```{important}
261+
If a submission is closed and the author wishes to re-submit, they will have to start a new submission.
262+
263+
If the package is still in scope, the author will have to
264+
respond to the first round of reviews first. After that is
265+
complete, you can begin looking for new reviewers to
266+
evaluated the package. This ensures that none of the review
267+
energy spent in the first review, goes to waste.
268+
```
269+
242270
### ✔️ 6. How to accept a package into the pyOpenSci ecosystem
243271

244272
Once the package has been accepted through the review process:

0 commit comments

Comments
 (0)