-
Notifications
You must be signed in to change notification settings - Fork 67
revise editors chapter for #487 #974
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
And rm previously separate 'Asking for more details' sub-section
|
@maelle This would be ready for review, but the Render Book workflow is failing, in ways I think related to babelquarto. The pandoc render of the English version works fine, then it moves on to the Spanish version and fails soon after then. I've seen those fails on other PR renders before, but they've always auto-resolved. This one seems not to want to do that. Any insights would be greatly appreciated, thanks! |
|
I'm investigating the CI problem, we had issues for a while recently then I fixed one workflow file and forgot to update the others. |
maelle
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! Soon we'll need a whole book for editors 😅
| All submissions are initially considered by the Editor-in-Chief, who makes the initial decision on whether a package is in scope. | ||
| If so, a handling editor is assigned who is then responsible for guiding the actual review process. | ||
|
|
||
| Please be aware that all people involved in the review process are volunteers who are freely and willingly devoting their own time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rather that those two sentences, use the same ones as at the top of the reviewer's guide about rOpenSci community being its best asset?
| The EiC is responsible for [general management](#eic-general) of the review process, and for the [initial stages](#eic-submission) of all submissions. | ||
|
|
||
| - Tagging each new full submission with ` 0/editorial-team-prep` | ||
| ### General EiC duties {#eic-general} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
on the dashboard page, how do you
- know when it's last been updated
- get a link to the workflow building it to investigate status if need be?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's updated daily, and issues a ping on any failures, visible to anybody watching the repo. That one virtually never fails - unlike others - so we don't really need to worry.
| - At the start of a rotation, the EiC should review the status of current open reviews on the [editorial dashboard](https://dashboard.ropensci.org/reviews.html), and issue reminders to other editors or package authors as needed. | ||
|
|
||
| - Regularly (for instance weekly) monitoring the pace of all open reviews by keeping an eye on the [*Dashboard* page](https://dashboard.ropensci.org/reviews.html), and reminding other editors to move packages along as needed. | ||
| - Watch all new issues posted to the software-review repo, for which the EiC must either subscribe to repo notifications on GitHub, or watch the `#editors-only` channel on Slack (ideally both). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why ideally both?!
| - Regularly (for instance weekly) monitor the pace of all open reviews by keeping an eye on the [*Dashboard* page](https://dashboard.ropensci.org/reviews.html), and reminding other editors to move packages along as needed. | ||
|
|
||
| - Making decisions on scope and overlap for pre-submission inquiries, referrals from JOSS or other publication partners, and submissions. Discussions should be initiated in the rOpenSci Slack editors-only channel through summarising the (pre-)submitted/referred software, along with any concerns the EiC might have. If after the EiC feels they haven't received enough answers after a day or two, they can ping all editors. | ||
| - Respond where appropriate to issues posted to the [software-review-meta repo](https://github.com/ropensci/software-review-meta/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if this should be a staff task.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I wonder that too. Shall we just remove it? (I think so)
| #### Deciding on scope and overlap | ||
|
|
||
| - Looking over submissions in "0\/presubmission" and "1\/editorial-team-prep", to check whether any action needs to be taken (such as polling editors, making decisions, putting issues on hold, pinging for updates, or finding and assigning editors). | ||
| The EiC is entitled to take scope and overlap decisions as independently as possible, but is recommended to request opinions on the `#editors-only` channel on Slack. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add that one should request opinions for submissions outside of one's areas of expertise.
| ``` | ||
| This will also add the tag `1/editor-checks` to the issue. | ||
|
|
||
| #### Statistical software submissions {#eic-stats-submissions} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should this content also exist as a short video intro to the stat system or would that get out of date too quickly?
| If rejected, see [this section](#outofscoperesponse) about how to respond. | ||
| - Ensure that the package gets tested on multiple platforms (having the package built on several operating systems via GitHub Actions for instance; see [criteria in this section of the CI chapter](#whichci) for further details and options). | ||
| - Wherever possible when asking for changes, direct authors to automatic tools such as [usethis](https://usethis.r-lib.org/), [Air](https://posit-dev.github.io/air/) and [styler](https://styler.r-lib.org/), and to online resources (sections of this guide, sections of the [R packages book](https://r-pkgs.org/)) to make your feedback easier to use. See this [example of editor's checks](https://github.com/ropensci/software-review/issues/207#issuecomment-379909739). | ||
| - Wherever possible when asking for changes, direct authors to automatic tools such as [usethis](https://usethis.r-lib.org/), [Air](https://posit-dev.github.io/air/) and [styler](https://styler.r-lib.org/), and to online resources (sections of this guide, sections of the [R packages book](https://r-pkgs.org/)) to make your feedback easier to use. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - Wherever possible when asking for changes, direct authors to automatic tools such as [usethis](https://usethis.r-lib.org/), [Air](https://posit-dev.github.io/air/) and [styler](https://styler.r-lib.org/), and to online resources (sections of this guide, sections of the [R packages book](https://r-pkgs.org/)) to make your feedback easier to use. | |
| - Wherever possible when asking for changes, direct authors to automatic tools such as [usethis](https://usethis.r-lib.org/), [Air](https://posit-dev.github.io/air/) and [styler](https://styler.r-lib.org/), and to online resources (sections of this guide, sections of the [R packages book](https://r-pkgs.org/)) to make your feedback easier to use. |
rm styler, add flir and jarl instead?
| - 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. | ||
| - In general aim for 3 weeks for review, 2 weeks for subsequent changes, and 1 week for reviewer approval of changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - In general aim for 3 weeks for review, 2 weeks for subsequent changes, and 1 week for reviewer approval of changes. | |
| - In general, aim for 3 weeks for review, 2 weeks for subsequent changes, and 1 week for reviewer approval of changes. |
|
|
||
| - **If the author stops responding**, refer to [the policies](#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, and thank them once again for their work. | ||
| Let the other editors know in the Slack channel to consider them for a package in the future with high chances of smooth software review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Let the other editors know in the Slack channel to consider them for a package in the future with high chances of smooth software review. | |
| Let the other editors know in the Slack channel to consider them as reviewers for a package in the future with high chances of smooth software review. |
| package, contact [an rOpenSci staff member](https://ropensci.org/about/#team) so they might contact the authors | ||
| about transfer to [the `ropensci-books` GitHub organisation](https://github.com/orgs/ropensci-books). | ||
| - Approve the package with `@ropensci-review-bot approve <package-name>` | ||
| - If the original repository wishes to keep the package in their own GitHub organization rather than transfer to rOpenSci, open a pull request adding the repository URL to [this repos list](https://github.com/ropensci/roregistry/blob/gh-pages/info/not_transferred.json) to ensure the package gets included in rOpenSci package registry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - If the original repository wishes to keep the package in their own GitHub organization rather than transfer to rOpenSci, open a pull request adding the repository URL to [this repos list](https://github.com/ropensci/roregistry/blob/gh-pages/info/not_transferred.json) to ensure the package gets included in rOpenSci package registry. | |
| - If the original repository wishes to keep the package in their own GitHub organization rather than transfer to rOpenSci, open a pull request adding the repository URL to this [list](https://github.com/ropensci/roregistry/blob/gh-pages/info/not_transferred.json) to ensure the package gets included in rOpenSci package registry. |
No description provided.