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.

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

Be more precise about what initial editor checks can contain? #352

Closed
maelle opened this issue Oct 21, 2021 · 6 comments
Closed

Be more precise about what initial editor checks can contain? #352

maelle opened this issue Oct 21, 2021 · 6 comments
Milestone

Comments

@maelle
Copy link
Member

maelle commented Oct 21, 2021

List to be completed

  • From a quick look at the README/pkgdown homepage, is the case for the package made well.
  • Is the documentation for human installation clear enough.
  • Is the reference index in pkgdown grouped by topic.
  • If the package has some interactivity / HTTP / plot production etc. are the tests using state-of-the-art tooling.
  • Is the documentation for contribution clear enough e.g. tokens for tests, playgrounds.
  • What is the state of the issue tracker, e.g. are there outstanding bugs, is it clear when feature requests are meant to be tackled.
  • What is the state of the PR tracker, e.g. are there stale PRs.
@maelle maelle added this to the 0.7.0 milestone Oct 21, 2021
@maelle
Copy link
Member Author

maelle commented Oct 21, 2021

Part of this might need to go the author guide as well.

@mpadge
Copy link
Member

mpadge commented Oct 21, 2021

Things which can be pkgchecked:

  • ref index for pkgdown grouped by topic
  • overview of stats on issues + PRs

I think that automating more means less written requirements for editors and reviewers, and easier or at least more informed reviews. Feel free to open issues in pkgcheck for these and anything else that might be usefully done there.

@emilyriederer
Copy link

I like to check the vignettes manually to ensure they seems readable and sufficiently detailed and not just perfunctory. I know that the bot already confirms their existence, and arguably the reviewer's are the ultimate arbiter of their quality. However, I feel like it is part of my obligation to ensure that those are meaty enough to help the reviewers do a good review, and it also helps me have more context to pick good reviewers and understand the review feedback.

@maelle
Copy link
Member Author

maelle commented Oct 22, 2021

@mpadge I agree and have opened two issues.

@emilyriederer Thank you, good point!

@maelle
Copy link
Member Author

maelle commented Nov 4, 2021

The PR is ropensci/software-review#482 as the template does not live here.

@maelle
Copy link
Member Author

maelle commented Nov 12, 2021

The PR above has been merged

@maelle maelle closed this as completed Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants