November 18, 2021 From rOpenSci (https://deploy-preview-488--ropensci.netlify.app/blog/2021/11/18/devguide-0.7.0/). Except where otherwise noted, content on this site is licensed under the CC-BY license.
rOpenSci Software Peer Review’s guidance is gathered in an online book and keeps improving! To find out what’s new in our dev guide 0.7.0, you can read the changelog, or this blog post for more digested information.
A big change brought in this release is the retirement of some of our multiple TODOs for editors in favor of simple bot commands such as @ropensci-review-bot check package.
Our editor guide is now simpler!
For context, rOpenSci has worked with The Journal of Open Source Software to extend JOSS’s approach of chatops-driven publishing into a new GitHub chat-bot, that manages our editorial process: assigning tasks, tagging issues, running tests on software submissions, and returning reports to reviewers and editors, logging reviews in an external (Airtable) database, all from the comfort of a GitHub issue comment. Chat-ops automation has been critical to JOSS’s success, and shows huge promise for automating even more tedious tasks like frequent software checks and compliance with best practices.
If you are curious about this topic, do not miss our next community call: Enhancing Software Peer Review with GitHub Automation! As usual resources and a close-captioned recording will be posted afterwards.
Fear not, software peer review volunteer editors still participate a lot in the process. We’ve formalized editor responsabilities, in particular outlining editor etiquette around submissions handled by other editors.
You do not have to keep track of other submissions, but if you do notice an issue with a package that is being handled by another editor, feel free to raise that issue directly with the other editor, or post the concern to editors-only channel on slack.
Thanks to the new statistical software peer-review editor Toby Dylan Hocking we’ve made it explicit that editors have to look for two reviewers.
Another element we’ve formalized a bit more is the list of human checks to be made by editors.
We’ve also added a whole chapter dedicated to editorial management with guidance for inviting, onboarding and offboarding editors. Recruiting new editors and maintaining a sufficient and well-balanced editorial board is a responsibility of the Software Review Lead (Noam Ross at this point in software review history 😀), with support and advice from the editorial board.
As with the rest of the Dev Guide, we hope this section helps make our own processes more transparent, and is of use to other organizations managing peer review.
In an effort to gather more relevant data about potential reviewers, we’ve improved our form for volunteering. It has more detailed questions about technical knowledge and domain expertise.
Thanks a lot to all who either updated their data or filled the form for the first time, we are very thankful for your willingness to participate to Software Peer Review!
To go with the new useful data we’ve updated the guidance for editors to look for reviewers.
If you want your info removed from the database, please send an email to privacy@ropensci.org.
We’ve sprinkled the dev guide with mentions of rOpenSci projects relevant to software review participants:
We’ve linked to Statistical Software Peer Review from the software review introduction and from the very first page of the book,
We present the pkgcheck package created and maintained by Mark Padgham in the author guide as using it enables authors to ensure their package is ready for submission.
In the packaging guide, we now give precise examples of tools for installation instructions: the r-lib remotes and pak packages but also R-universe!
Following our community call “Set Up Your Package to Foster a Community” that has been summarized by Sina Rüeger, we’ve added guidance to our collaboration guide.
The work on pkgcheck and automation means we were able to remove some elements from reviewers' guidance:
We no longer ask reviewers to run covr but we ask them to pay attentions to skipped tests.
We no longer ask reviewers to run goodpractice as goodpractice is run by the pkgcheck package whose checks are triggered on the cloud by the bot.
We are thrilled to remove some workload from reviewers as we are aware that reviewing a package is a lot of work. Thanks to all reviewers for their incredible contributions to Software Peer Review!
The requirement to have a vignette is now more precise, there has to be at least one HTML vignette. That requirement is part of pkgcheck checks.
Thanks to an idea of editor Anna Krystalli, the dev guide now includes an explicit subsection about version control, and pkgcheck’s checks include looking for “scrap files” such as .DS_Store files, that should be .gitignore’d.
We’ve added some more guidance on making packages easier to cite following our blog post on the same topic.
We’ve clarified the definition of the categories “data extraction” and “data munging” by adding examples.
In this post we summarized the changes incorporated into our book “rOpenSci Packages: Development, Maintenance, and Peer Review” over the last months. We are thankful for all contributions that shaped this release. We are already working on the next version, such as pondering whether to make the review template an R Markdown file and whether to make a distinct chapter out of contributing guide standards
