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: how-to/onboarding-guide.md
+20-23Lines changed: 20 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ and reviewers. Finding new volunteers to take on editorial and reviewer roles
5
5
can sometimes be the trickiest part of the review process. However, we have
6
6
resources available to help you in that effort!
7
7
8
-
Below we discuss processes for finding and onboarding new volunteers to our
8
+
Below, we discuss processes for finding and onboarding new volunteers to our
9
9
peer review process.
10
10
11
11
## About the Editorial Board
@@ -17,49 +17,49 @@ editorial board. Our board needs to have combined expertise in:
17
17
review process
18
18
* Technical expertise in Python packaging
19
19
* Awareness of the importance of documentation and package usability
20
-
* Awareness of the importance of CI / test suites to ensure robust software
20
+
* Awareness of the importance of CI/test suites to ensure robust software
21
21
development
22
22
23
23
We also strive to ensure our editorial team is diverse and comprised of people
24
24
from different backgrounds, cultures, genders, and domains.
25
25
26
-
### Types of Editors
26
+
### Types of editors
27
27
28
-
#### New Editors Start as "Guests"
28
+
#### New editors start as "Guests"
29
29
30
30
A new editor will be considered a guest editor for the first 3 months of their
31
-
tenure and/or until they have completed their first review. Once they have
32
-
completed a review, they can be considered a full editor as deemed appropriate
31
+
tenure and/or until they have completed their first review. Once a Guest Editor has
32
+
completed a review, they are considered a full editor as deemed appropriate
33
33
by the Software Review Lead and the current editorial board.
34
34
35
-
#### _ad hoc_Guest Editors
35
+
#### _ad hoc_guest editors
36
36
37
-
Adhoc editors are editors with specific skill sets that are brought in to lead
38
-
a single review. Examples of when there might be a need for an _ad hoc_ editor
37
+
An ad hoc editor has specific skill sets that are required to lead
38
+
a single review. Examples of when pyOpenSci needs an _ad hoc_ editor
39
39
include:
40
40
41
41
* If there is a conflict of interest between a package submitter and the
42
-
editorial team (e.g., a close colleague of everyone on the team)
43
-
* If the editorial board is at capacity handling the current review load
42
+
editorial team (for example, a close colleague of everyone on the team)
43
+
* If the editorial board is at capacity, handling the current review load
44
44
* If a very specialized skill set is needed (in a one-off type of situation)
45
45
46
46
In this case, you may consider using our internal reviewer sign-up list to see
47
-
if someone who signed up to be a reviewer might want to serve as an editor.
47
+
if someone who signed up to be a reviewer wants to serve as an editor.
48
48
49
-
### Experience Required to Be an Editor
49
+
### Experience required to be an editor
50
50
51
51
We prefer that editors have some experience with reviewing software. This
52
52
experience could come from a previous review they worked on with pyOpenSci,
53
53
rOpenSci, or JOSS.
54
54
55
-
### Editorial Mentorship
55
+
### Editorial mentorship
56
56
57
57
If a potential volunteer does not have prior software editorial experience, we
58
58
offer a **mentorship process**. Editor mentorship is where someone with
59
59
existing editorial experience mentors the new editor through their first
60
60
review(s).
61
61
62
-
### Recruiting New Editors
62
+
### Recruiting new editors
63
63
64
64
Recruiting new editors and maintaining a sufficient and well-balanced
65
65
editorial board is the responsibility of the
@@ -74,7 +74,7 @@ future, we will find someone with interest in leading peer review for
74
74
pyOpenSci.
75
75
:::
76
76
77
-
## Where to Find New Editors
77
+
## Where to find new editors
78
78
79
79
Typically the Editor in Chief will work with the Software Review Lead to find and
80
80
onboard new editors in scientific topical areas where pyOpenSci has existing
@@ -200,7 +200,7 @@ We think you will make a wonderful addition to our pyOpenSci open review team!
200
200
201
201
[Here is an onboarding document to help you navigate your first weeks in this role.](https://docs.google.com/document/d/1UfG1Fe5wSiEAObvqNMT4etZ5sx7QXzW0f8mozKyK1NE/edit?tab=t.0)
202
202
203
-
[IF GUEST EDITOR: You are familiar with the editor's role, as you've been a guest editor]. We aim for editors to handle reviews for four packages per year
203
+
[IF GUEST EDITOR: You are familiar with the editor's role, as you've been a guest editor]. We aim for editors to handle reviews for four packages per year
204
204
([IF GUEST EDITOR including the one that you just finished!]).
205
205
We ask that editors make an informal commitment to serve for two years and
206
206
re-evaluate their participation after that.
@@ -277,8 +277,9 @@ You do not need to fill out all of the elements of the YAML file - only the name
277
277
When it is time for an editor to step down, do the following:
278
278
279
279
* Thank them for their work!
280
-
* Remove them from the editors-only Slack channel and the editors GitHub team.
281
-
* Move them to emeritus-editor on the [pyOpenSci website](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/contributors.yml) as follows:
280
+
* Announce that they are stepping down, and than them in the private editors-only Slack channel. Then, remove them from the editors-only Slack channel.
281
+
* Remove them from the [Editorial-Board GitHub team](https://github.com/orgs/pyOpenSci/teams/editorial-board).
282
+
* Move them to `emeritus-editor` on the [pyOpenSci website](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/contributors.yml) by editing the yaml file as follows:
282
283
283
284
```yaml
284
285
- name: FirstName LastName
@@ -288,8 +289,4 @@ When it is time for an editor to step down, do the following:
288
289
editorial_board: false # Be sure editorial_board is set to FALSE
289
290
emeritus_editor: true # Emeritus is now true if they've served as an editor
290
291
# .. #
291
-
contributor_type:
292
-
- editor # This field will be automatically updated after their first review
0 commit comments