Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Revise Guide for Editors Chapter #487

Open
6 tasks
mpadge opened this issue Jun 30, 2022 · 4 comments
Open
6 tasks

Revise Guide for Editors Chapter #487

mpadge opened this issue Jun 30, 2022 · 4 comments
Assignees
@mpadge
Labels
content 📃
Milestone
1.0.0

Comments

@mpadge
Copy link
Member

mpadge commented Jun 30, 2022

Beyond #486, the chapter could do with a restructure. In particular:

  • Ensure chapter follows actual typical workflow, so EiC first, then editor (plus further considerations below)
  • Revise current "out-of-scope" primary sub-section to make part of EiC responsiblities
  • Expand that sub-section to consider other aspects of general question of fit or not, including aspects such as "thin wrappers" (Update the scope for API wrappers #478), and explicitly describing/demonstrating how the statisical summary can be used to judge whether packages may not have enough code, functions, whatever to be worth reviewing.
  • Move current "Answering reviewers' questions primary sub-section within broader "Handling Editors" sub-section
  • Rename "Handling Editors Checklist" primary sub-section to something more general ("Handling Editors Responibilities")
  • Maybe separate Handling Editor sub-section into several distinct sub-sections (Upon Submission; Finding and Assigning Reviews; Managing the Review Process).

Any initial thoughts @maelle @noamross?
@mpadge mpadge added this to the 0.9.0 milestone Jun 30, 2022
@mpadge mpadge self-assigned this Jun 30, 2022
@maelle
Copy link
Member

maelle commented Jul 4, 2022

Thank you!!

Does it mean we should assign #478 to you so you might handle both issues in a single PR?

@maelle
Copy link
Member

maelle commented Jul 4, 2022

All changes sound good to me.

@maelle
Copy link
Member

maelle commented Dec 12, 2023

@mpadge ready to make a PR for this? I'd then run babeldown::deepl_update() 😁

@mpadge mpadge modified the milestones: 0.9.0, 1.0.0 Feb 22, 2024
@maelle
Copy link
Member

maelle commented Feb 3, 2025

What's missing from the editor guide is what an editor should check before handing off to reviewers. And what the editor should not do as the editor checks are not a review but we do want to take some load off reviewers if we can and notice something amiss. 🤪

  • Ensure the goal of the package is clear from reading the README.
  • Check one's favorite nitpicks... but hopefully these ones should end up in pkgcheck or the dev guide? Like, I always check for top-level code in tests or expectations that have a more specific equivalent.

Maybe ask other editors what they usually do? Or read editor checks myself?

@maelle maelle pinned this issue Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mpadge mpadge

Labels
content 📃
Projects
None yet
Milestone
1.0.0
Development

No branches or pull requests
2 participants
@mpadge @maelle