Skip to content

Commit 67d0470

Browse files
Carter Rhealwasser
authored andcommitted
Updated editors guide to heopfully make it more clear when the reviewers should be added to the initial response
1 parent c295612 commit 67d0470

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

appendices/editor-initial-response-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
---
55

66
## Editor comments
7-
:wave: Hi @reviewer-one and @reviewer-two! Thank you for volunteering to review
8-
for pyOpenSci! <Add any additional banter here that you wish..>
7+
<Add additional banter here that you wish..>
8+
<In step 3 you will add a welcome message to the reviewers>
99

1010

1111
### Please fill out our pre-review survey

how-to/editors-guide.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ All reviews happen in GitHub issues. The template for the
120120
`yaml` header of a review submission below will be
121121
referenced multiple times in the steps below:
122122

123-
```{include} ../appendices/issue-review-template.md
123+
```{include}
124124
125125
```
126126

@@ -141,7 +141,7 @@ Repository Link: REPO-LINK
141141
Version submitted: VERSION-SUBMITTED
142142
```
143143

144-
```{admonition} Editor in Chief checks for structure & scope should be completed first
144+
```{admonition}
145145
:class: note
146146
147147
The editor in chief who initially engaged with this review should have already evaluated the package level Editor Checks section for `Fit`, `Automated Tests`, `Documentation`, `License`, and `Repository`.
@@ -166,8 +166,9 @@ we are using our volunteer reviewer time effectively.
166166

167167
- Add a comment to the issue that contains an **exact** copy of the Editor Response template (see below) filled out with your response to the checks that begin the review.
168168
- Change the label of the issue to `2/seeking-reviewer(s)`
169+
- Note that, at this stage, you likely do not have reviewers yet!
169170

170-
```{include} ../appendices/editor-initial-response-template.md
171+
```{include}
171172
172173
```
173174

@@ -201,7 +202,7 @@ This type of communication just lets the author know that the process is
201202
moving forward. Even if it takes longer to find reviews, authors generally
202203
appreciate the communication and understand it's a volunteer-lead process.
203204

204-
```{admonition} Diversity in the editorial & reviewer team is important
205+
```{admonition}
205206
:class: important
206207
207208
Diversity is core to the pyOpenSci mission. As such it's important to have an
@@ -215,7 +216,7 @@ in the team supporting package review. Specifically both reviewers should have [
215216

216217
If you wish, you can use the email template below to invite reviewers.
217218

218-
```{include} ../appendices/reviewer-request-template.md
219+
```{include}
219220
220221
```
221222

@@ -225,10 +226,15 @@ deadline when you'll move on to looking for someone else to keep the processing
225226
moving.
226227

227228
- Once you have assigned reviewers to the review, you will update the editor response above with:
228-
229229
1. reviewer GitHub handles and
230230
2. the review deadline date.
231231

232+
```{info}
233+
At this point you can add the following to the **Editor Response to Review** under **Editor Comments**:
234+
`:wave: Hi @reviewer-one and @reviewer-two! Thank you for volunteering to review
235+
for pyOpenSci!`
236+
```
237+
232238
- Change the label on the issue to `3/reviewer(s)-assigned`
233239

234240
```{warning}
@@ -319,7 +325,7 @@ Once the package has been accepted through the review process:
319325
approved to the pyOpenSci website. They can perform this step regardless of the
320326
JOSS submission process.
321327

322-
```{include} ../appendices/package-approval-template.md
328+
```{include}
323329
324330
```
325331

@@ -387,8 +393,9 @@ Once the package is accepted by JOSS and the DOI badge resolves properly:
387393
Once the review is complete, you can close the issue. Before doing that:
388394

389395
- Be sure that the issue is correctly tagged with `6/pyOS-approved` (and `9/joss-approved` if authors decided to submit to JOSS and were accepted).
390-
- Check the pyOpenSci website to ensure:
391396

397+
- Check the pyOpenSci website to ensure:
398+
392399
- The package was properly added to the [pyOpenSci website](https://www.pyopensci.org/python-packages/).
393400
- Reviewers and maintainers are listed on the [contributors page](https://www.pyopensci.org/our-community/).
394401
- Make sure the YAML at the top of the issue is fully filled out and up to date.

0 commit comments

Comments
 (0)