Skip to content

Commit c5889bd

Browse files
authored
fix: add more direction on labels and tracking reviews to editor guide (pyOpenSci#339)
1 parent e698a37 commit c5889bd

3 files changed

Lines changed: 36 additions & 8 deletions

File tree

how-to/editor-in-chief-guide.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,21 @@ responding to out-of-scope pre-submissions.
9696
If the EiC has limited time to handle [pre-review checks](pre-review-checks) for a package, a conflict of interest, or lacks relevant expertise, they may ask another editor to perform initial checks on a package at any time.
9797
:::
9898

99-
## Editor in Chief checklist
99+
## Editor in Chief pre-review submission checklist
100+
101+
The EiC is also responsible for determining the scope of packages submitted via a pre-submission inquiry.
102+
103+
The steps include:
104+
105+
1. **Determine if the package is in scope for review:** Have a look at the pre-submission inquiry. Use our [project scope page](https://www.pyopensci.org/software-peer-review/about/package-scope.html) to determine whether that package is in scope for pyOpenSci review.
106+
2. If the package is in scope, add the `submission-requested` label to the pre-submission inquiry.
107+
3. Let the author know that `pre-review` checks are next and will happen in the full submission issue. At this stage, it's a good idea to let the author know that the package will undergo pre-review checks upon submission for review. You can share the [pre-review checks template with the author at this time if you wish](editor-checklist-template)
108+
109+
:::{note}
110+
It is OK to perform pre-review checks in the pre-review submission if you wish. However, for documentation purposes, you will need to perform them in the full submission issue, as that is what JOSS and other partners look at. Be sure that you aren't duplicating your time!
111+
:::
112+
113+
## Editor in Chief peer review checklist
100114

101115
When a new package is submitted for review, the Editor in Chief should:
102116

@@ -127,6 +141,9 @@ existing community, please check below:
127141
(pre-review-checks)=
128142
### 3. ✔️ Add the pre-review checks to the issue
129143

144+
When you add `pre-review` checks to the issue, remove the `New Submission!` label from the issue.
145+
This lets people know that someone is working on the issue and moving it forward.
146+
130147
:::{important}
131148
Post your complete pre-review/editor checks in **one single comment**, rather than in multiple
132149
comments. This keeps the review easy to follow and lets the author address
@@ -179,8 +196,8 @@ to check which editors are currently available and what domains those editors ar
179196

180197
Once you’ve selected an editor:
181198

182-
1. Assign the issue to them in GitHub
183-
2. Update the YAML at the top of the issue with their GitHub username
199+
1. **Assign the issue to that editor in GitHub** This step helps us keep track of who is running which reviews. Please do not forget to do this!
200+
2. Update the editor section of the YAML at the top of the issue with their GitHub username
184201
3. Add the `1/editor-assigned` label to the issue
185202

186203
:::{note}

how-to/editors-guide.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -115,11 +115,21 @@ referenced multiple times in the steps below:
115115
116116
```
117117

118-
### ✔️ 1. First, tag the submission issue on GitHub
118+
### ✔️ 1. First, tag the submission issue on GitHub & assign yourself to the issue
119119

120120
Once you begin the review process as an editor:
121121

122122
- Tag the submitted GitHub issue with the `1/editor-checks` tag if it hasn't already been tagged by the editor-in-chief.
123+
- Make sure that you are assigned to the issue on GitHub (ie, your name is on the right-hand side of the issue as the person running it).
124+
125+
:::{figure-md} assign-editor
126+
127+
<img src="../images/assign-issue.png" alt="Screenshot showing the right-hand side of a GitHub issue with the editor assigned to the issue." width="700px">
128+
129+
Make sure that your name is both listed in the YAML at the top of the issue and also that you are assigned to the issue on GitHub (on the right-hand side of the issue).
130+
:::
131+
132+
123133
- Check the YAML template at top of the submitted GitHub issue, make sure that mandatory parts of the template are filled out.
124134
- If elements are incomplete, direct the authors toward filling in any missing pieces.
125135

@@ -135,17 +145,17 @@ Version submitted: VERSION-SUBMITTED
135145
```{admonition} Editor in Chief checks for structure & scope should be completed first
136146
:class: note
137147
138-
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`.
148+
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`.
139149
140150
They also should have checked whether the package is [in scope for pyOpenSci](../about/package-scope).
141151
And whether there is [functionality overlap with functionality of any other existing Python packages](package-overlap).
142152
143-
However, in some instances the editor-in-chief may request that an editor
144-
perform these tasks. Be sure to check the issue to ensure the above checks have been implemented prior to initiating the review.
153+
However, in some instances, the editor-in-chief may request that an editor
154+
perform these tasks. Be sure to check the issue to ensure the above checks have been implemented before initiating the review.
145155
146156
If the package does not fit the pyOpenSci scope and policies and needs to be
147157
rejected, see
148-
[this section in the editor in chief guide](editor-in-chief-guide.md#responding-to-out-of-scope-submissions)
158+
[this section in the editor-in-chief guide](editor-in-chief-guide.md#responding-to-out-of-scope-submissions)
149159
about how to respond.
150160
```
151161

@@ -257,6 +267,7 @@ ensure that things are moving smoothly:
257267
- Check in with reviewers and authors occasionally. Offer clarification and help as needed.
258268
- Aim for ~3 weeks for review, 2 weeks for subsequent changes, and 1 week for reviewer approval of changes.
259269
- If a review has not been submitted after 2 weeks, ping the reviewer(s) within the review issue to ensure they are aware of the 3-week deadline.
270+
- If you are waiting for a maintainer to respond to you, be sure to add the label `pending-maintainer-response` to the issue.
260271

261272
### ✔️ 5. What to do when reviews are in
262273

images/assign-issue.png

49.2 KB
Loading

0 commit comments

Comments
 (0)