Search
Reviewer: @githubname1
Reviewer: @githubname2
Due date: YYYY-MM-DD
  • Switch numbered tag to 3/reviewers-assigned once reviewers are assigned.

Where to look for reviewers?

As a (guest) editor, use:

  • the potential 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).
  • the authors of pyOpenSci packages.

When these sources of information are not enough:

  • ping other editors for ideas.
  • look for users of the package or of 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.

Criteria for choosing a reviewer

Here are criteria to keep in mind when choosing a reviewer. You might need to piece this information together by searching CRAN and the potential reviewer’s GitHub page and general online presence (personal website, Twitter).

  • Has not reviewed a package for us within the last 6 months.
  • Some package development 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 - with two reviewers both shouldn’t be cis white males.
  • Some evidence that they are interested in openness 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 in two. Both reviewers need to review the package comprehensively, though from their particular perspective. In general, at least one reviewer should have prior reviewing experience, and of course inviting one new reviewer expands our pool of reviewers.

During review:

  • 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.
  • Upon all reviews being submitted, change the review status tag to 4/review-in-awaiting-changes to update the reminder bot.
  • If the author stops responding, refer to the policies and/or ping the other editors in the Slack channel for discussion. Importantly, 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 chances of smooth software review next time (e.g. a package author who has already submitted packages to us).
  • Upon changes being made, change the review status tag to 5/awaiting-reviewer-response.

After review:

  • Change the status tag to 6/approved.
  • You can use the approval comment template.
  • Add review/er information to the review database.
  • Ask authors to migrate to pyOpenSci
    • 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 pyOpenSci
    • Go to the repository settings in the "pyOpenSci" GitHub organization and give the author "Admin" access to the repository.
  • Ask author to:
    • Change any needed links, such those for CI badges
    • 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=master&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 repo.
  • Close the software-review issue.

Responding to out-of-scope submissions

Thank authors for their submission, explain the reasons for the decision, and direct them to other publication venues if relevant, and to the pyOpenSci governance repo issues for discussion. Use wording from Aims and scope in particular regarding the evolution of scope over time, and the overlap and differences between unconf/staff/software-review development.