Guide for Editors
Guide for Editors#
Thank you for your time in serving as an editor for a PyOpenSci package! Below you will find some information about the role that editors have in the pyOpenSci Python open source peer review process.
Editors generally should:
Have completed a review for at least 1 package for pyOpenSci.
Have some experience with open source software that supports the scientific Python community, be it maintaining or contributing to packages or being involved in the community in some way.
There are two types of editors in our peer review process:
Guest editors and
Both types of editors are considered a part of the editorial board for pyOpenSci. The major difference between guest and full editors is the time that they may or may not serve on the editorial board. And the support that they may need in serving as editor.
A guest editor is is invited to lead a review in the case where we need specific expertise for a single review. We also consider editors who are performing their first review as guest editors as they may require more guidance or mentorship to complete the review (if they are new to our organization).
New editors who wish to continue on as full editors for pyOpenSci may do so as long as both parties (pyOpenSci and the guest editors) feel like it is a healthy fit for them and the organization.
Editors and the Editorial Board#
A full editor most often someone who has experience with the pyOpenSci open package review process. A full editor ideally:
has completed a review for atleast 1 package for pyOpenSci
and/or has submitted and gone through the pyOpenSci package review process
and/or has experience reviewing for an organization such as JOSS or rOpenSci.
We also appreciate when editors have some experience working with or in the Python open source software community be it maintaining or contributing to packages, or being involved in the community in some way. This is certainly now a required however if you are interested in getting involved through pyOpenSci!
There could be certain situations when an editor is on boarded with less experience! The above are simply guidelines that we like to follow.
What does an editor do? (Responsibilities)#
An editor is normally recruited by the Editor in Chief, other editors on the board, or the software review lead. More on recruiting editors can be found here.
An editor is responsible for:
Leading the review process for 3-4 packages a year
Weighing in on group editorial decisions such as whether a package is in-scope, and making updates to the pyOpenSci policies.
Decisions surrounding policy, updates to peer review guides and decisions
on package review are generally made in the private
editorial-board channel in the pyOpenSci Slack organization. Please make sure that you
are comfortable with checking Slack regularly.
Supporting other reviews#
While editors are not charged with tracking other submissions that they are not leading, if you do notice an issue with another review, please feel free to raise that issue either directly with the editor for that review OR raise the issue in the editors channel in slack.
Editor in chief rotation#
The editorial board normally participates in the Editor in Chief rotation. You are eligible to enter this rotation after 3 months of serving on the board and/or after your first review as it makes sense. Read more about the roles and responsibilities of the Editor in Chief, here.
If the Editor in Chief role feels like too much responsibility, an editor can also decline being a part of this rotation.
How long does an editor serve on the editorial board?#
Ideally an editor can commit to serving for atleast one year as an editor for pyOpenSci. During that year we expect that you will lead review of 3-4 packages. However, we understand that in certain situations, an editor may need to step down before the 1 year time period has ended.
We also understand that life gets busy and you are always welcome to “say no” to a review during a particularly busy time.
We welcome editors staying on for longer as long as they are happy serving with us and they get along well with other members of the editorial board, the software review lead and the current Editor in Chief.
Get Started With Leading a Package Review – Checklist#
Follow the checklist below when serving as an editor for a package submitted to pyOpenSci for review.
✅ 1. First, tag the submission issue on GitHub#
Once you begin the review process as an editor:
Tag the submission issue with the
Check the submission by the author to ensure that mandatory parts of the template are complete.
If elements are incomplete, direct the authors toward filling in any missing pieces.
✅ 2. Respond to the submitter in the GitHub issue#
Once the above is complete, you are ready to add editor checks to the issue. The goal of this step is to ensure that the package is ready to be reviewed. Following this step will ensure that we are using our volunteer reviewer time effectively.
Add a comment to the issue that contains a copy of the Editor Checks template (see below) filled out with your response to the checks that begin the review.
In this comment, you will add reviewers and the review deadline date once you have reviewers assigned (see below).
## Editor checks: --- ## Editor comments :wave: Hi @reviewer-one and @reviewer-two! Thank you for volunteering to review for PyOpenSci! <Add any additional banter here that you wish..> The following resources will help you complete your review: 1. Here is the **[reviewers guide](https://www.pyopensci.org/contributing-guide/peer-review-guides/reviewer-guide.html)**. This guide contains all of the steps and information needed to complete your review. 2. Here is the **[review template](https://www.pyopensci.org/contributing-guide/appendices/templates.html#review-template)** that you will need to fill out and submit here as a comment, once your review is complete. Please get in touch with any questions or concerns! Your review is due: <Insert deadline DATE HERE> --- Reviewers: Due date:
Fill out the Editor Checks section for
Check against policies for package fit within identified categories for the pyOpenSci ecosystem.
Check against policies for package overlap of functionality with other packages.
If the package does not fit the pyOpenSci scope and policies and needs to be rejected, see this section in the editor in chief guide about how to respond.
PyOpenSci has a partnership with JOSS where packages that are in-scope for JOSS can be directly accepted into the JOSS ecosystem through the pyOpenSci review. The JOSS component of the review happens after all of the review on the pyOpenSci side is complete and it begins through direct communication with a JOSS editor.
Versionwithin the editor checks for JOSS may be filled out at the end of the review.
Archiverefers to an archive created through a release. You can use zenodo to create this archive and provide the package with a citable DOI. If zenodo is used, please add the zenodo link here.
Versionrefers to the final package version that was accepted by pyOpenSci. This is the final version as presented after all feedback from the reviews has been considered and implemented.
Important: If initial checks show major gaps, request changes before assigning reviewers.
3. Identify Reviewers#
Within one week of completing the editor checks, identify two reviewers for the package.
If you wish, you can use the email template to invite reviewers. When inviting reviewers, include something like “if I don’t hear from you in a week, I’ll assume you are unable to review,” so as to give a clear deadline when you’ll move on to looking for someone else to keep the processing moving.
Where to Look for Reviewers?#
As a (guest) editor, you can find reviewers through:
Suggestions made by the submitter(s) (although submitters may have a narrow view of the types of expertise needed. We suggest not using more than one of suggested reviewers).
Authors of existing pyOpenSci packages.
Other contributors to pyOpenSci.
When these sources of information are not enough:
Ping other editors for ideas.
Look for users of the package or the data source/upstream service the package connects to (via their opening issues in the repository, starring it, citing it in papers, talking about it on Twitter).
You can also search for authors/maintainers of related packages on PyPI.
Post on Twitter and ensure pyOpenSci retweets your post.
Criteria for Choosing Reviewers#
Here are criteria to keep in mind when choosing a reviewer. You might need to
piece this information together by searching
the potential reviewer’s GitHub page and general online presence (personal
Has not reviewed a package for us within the last 6 months.
Some package development / contribution experience.
Some domain experience in the field of the package or data source.
No conflicts of interest.
Try to balance your sense of the potential reviewer’s experience against the complexity of the package.
Diversity - if you have two reviewers both shouldn’t be cis white males.
Openness - reviewers should also have demonstrated interest in open source or Python community activities, although blind emailing is fine.
Each submission should be reviewed by two package reviewers. Although it is fine for one of them to have less package development experience and more domain knowledge, the review should not be split into two parts. Both reviewers need to review the package comprehensively, from their particular perspectives. In general, at least one reviewer should have prior reviewing experience, and of course inviting one new reviewer expands our pool of reviewers.
Reviewers should ideally have some subject matter expertise associated with the package functionality. It is ok and even welcome if one reviewer has more technical expertise and the other focuses on usability and is less technical. Read through the Guidelines for Reviewers Section to learn more about finding and selecting reviewers.
PyOpenSci has been piloting a new reviewer mentorship program where we pair a new reviewer with someone in the community with previous review experience. If a new reviewer is interested in this, get in touch with the editor in chief.
4. Onboard Reviewers#
Once reviewers have been identified:
Modify the Editor Comments under Editor Checks to add reviewer names and assign due date (typically a 2-3 week turn around).
Also add the reviewers to the initial top comment in the issue.
Reviewers: Full Name (@github_username) and Full Name (@github_username) Due date: Date` Include in your comment to the reviewers: - Link to the reviewer guide for reviewers - Link to the review template
Edit the original comment submitted by author to fill in the Editor and Reviewer Information:
Editor: Full Name (@github_username) Reviewer 1: Full Name (@github_username) Reviewer 2: Full Name (@github_username) Archive: Filled out when the review is complete. Version accepted: Filled out when the review is complete.
Tag issue with
Editor Responsibilities During the Review:#
During the review process, it is important to check in with the reviewers to ensure that things are moving smoothly:
Check in with reviewers and authors occasionally. Offer clarification and help as needed.
In general aim for 3 weeks for review, 2 weeks for subsequent changes, and 1 week for reviewer approval of changes.
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.
Once all reviews are submitted, change the review status tag to
If the author stops responding, refer to the policies and/or ping the other editors in the Slack channel <Not available publically yet> for discussion.
Upon changes being made, change the review status tag to
If a reviewer was assigned to a closed issue, contact them when closing the issue to explain the decision, thank them once again for their work, and make a note in our database to assign them to a submission with high chance of smooth software review next time (e.g. a package author who has already submitted packages to us).
General Review guidelines#
For packages needing continuous integration on multiple platforms (criteria in this section of the packaging chapter), make sure the package gets tested on multiple platforms (e.g. MAC, Windows, Linux).
Wherever possible when asking for changes in the review process, direct authors to automatic tools and online resources.
If the package raises a new issue for pyOpenSci policy, create an issue on pyOpenSci’s governance repo.
Editor Responsibilities After the Review:#
Once the package has been accepted through the review process:
Change the status tag of the issue to
Update the top of the issue with the version of the package that was approved and the DOI.
Instructions for Submitting to JOSS:#
If the package fits within the JOSS Scope, once the package has been approved by pyOpenSci:
Tag the issue
Instruct the author to read the
paper.mdfile requirements for JOSS and ensure that paper is added to the repo.
Direct the package author to follow the instructions to submit the package to JOSS.
These instructions loosely include:
Login to the JOSS website and fill out the JOSS submission form. When you fill out the form, be sure to mention and link to the approved pyOpenSci review.
Wait for a JOSS editor to approve the presubmission (which includes a scope check).
The scope of packages accepted by pyOpenSci is sometimes different from those accepted by JOSS. Not all pyOpenSci accepted packages will be accepted by JOSS. Further, packages that have been previously published elsewhere may not be eligible to be published with JOSS unless significant changes and improvements to package functionality have been made.
JOSS will accept the pyOpenSci review and direct the author to check their
paper.md file. Once the package is accepted by JOSS,
the author will be instructed to add the JOSS DOI badge to their package README file.
Once the package is accepted by JOSS and the DOI badge resolves properly:
If the package was accepted by JOSS:
Versionaccepted in the Editor Checks comment and at the top of the issue.
Version acceptedin the original comment submitted by the author.
Tag the issue with
You may wish to use the approval template below in the issue. This template asks the authors and reviewers to add themselves and the package that was approved to the pyOpenSci website. They can do this step regardless of the JOSS submission process.
---------------------------------------------- 🎉 <package-name-here> has been approved by pyOpenSci! Thank you <maintainer-name-here> for submitting <package-name> and many thanks to <reviewer-names-here> for reviewing this package! 😸 There are a few things left to do to wrap up this submission: - [ ] Activate Zenodo watching the repo if you haven't already done so. - [ ] Tag and create a release to create a Zenodo version and DOI. - [ ] Add the badge for pyOpenSci peer-review to the README.md of <package-name-here>. The badge should be `[![pyOpenSci](https://tinyurl.com/y22nb8up)](https://github.com/pyOpenSci/software-review/issues/issue-number)` - [ ] Add <package-name> to the pyOpenSci website. <maintainer-name>, please open a pr to update [this file](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/packages.yml): to add your package and name to the list of contributors - [ ] <reviewers-and-maintainers> if you have time and are open to being listed on our website, please add yourselves to [this file](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/contributors.yml) via a pr so we can list you on our website as contributors! <IF JOSS SUBMISSION> It looks like you would like to submit this package to JOSS. Here are the next steps: - [ ] Login to the JOSS website and fill out the JOSS submission form using your Zenodo DOI. **When you fill out the form, be sure to mention and link to the approved pyOpenSci review.** JOSS will tag your package for expedited review if it is already pyOpenSci approved. - [ ] Wait for a JOSS editor to approve the presubmission (which includes a scope check) - [ ] Once the package is approved by JOSS, you will be given instructions by JOSS about updating the citation information in your README file. - [ ] When the JOSS review is complete, add a comment to your review in the pyOpenSci software-review repo that it has been approved by JOSS. 🎉 Congratulations! You are now published with both JOSS and pyOpenSci! 🎉 <IF JOSS SUBMISSION/> All -- if you have any feedback for us about the review process please feel free to share it here. We are always looking to improve our process and documentation in the [contributing-guide](https://www.pyopensci.org/contributing-guide). We have also been updating our documentation to improve the process, so all feedback is appreciated!
Last Steps Before Closing the Review Issue#
Once the review is complete, you can close the issue. Before doing that:
Be sure that the issue is tagged with
Followup with authors and reviewers to ensure:
If the package is approved by JOSS, be sure that the issue is tagged with
7/JOSS-approvedand that the archive / DOI information is updated before closing the issue.
Congratulations, you have completed a review for pyOpenSci!
Optional - Move Package to PyOpenSci Organization (BETA)#
rOpenSci packages often live in the rOpenSci organization. PyOpenSci is still figuring out whether this model fits the Python community. If an author is interested in this option, consider doing the following:
If the package will be migrated to
Create a two-person team in pyOpenSci’s “pyOpenSci” GitHub organization, named for the package, with yourself and the package author as members.
Have the author transfer the repository to
Go to the repository settings in the “pyOpenSci” GitHub organization and give the author “Admin” access to the repository.
Ask the author to:
Change any needed links, such as those for CI badges.
Add pyOpenSci badge:
Re-activate CI services:
For Travis, activating the project in the pyOpenSci account should be sufficient.
For AppVeyor, tell the author to update the GitHub link in their badge, but do not transfer the project: AppVeyor projects should remain under the authors’ account. The badge is
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/pyOpenSci/pkgname?branch=main&svg=true)](https://ci.appveyor.com/project/individualaccount/pkgname).
For Codecov, the webhook may need to be reset by the author.
Add a “peer-reviewed” topic to the repository.