Skip to content

Package review checklist 2.1.0: scope, AI disclosure, test quality, executable examples, Hub data packages; fix stale link and duplicates - #183

Open
lwaldron wants to merge 1 commit into
Bioconductor:develfrom
lwaldron:checklist-2.1.0
Open

lwaldron wants to merge 1 commit into
Bioconductor:develfrom
lwaldron:checklist-2.1.0

Conversation

@lwaldron

Copy link
Copy Markdown

While mapping every bullet of the review checklist onto an agent-assisted review helper we're building (Sean Davis, Marcel Ramos and I; more on that when it's ready to show), I ended up comparing v2.0.0 line by line against the current guide. Most of it maps cleanly. This PR fixes the places where it doesn't, plus a few things the guide asks for that the checklist never mentions. Nothing here changes policy; it brings the checklist in line with chapters that already exist, and with what reviewers already ask for in practice.

Added

  • General: an explicit scope bullet (in scope for Bioconductor, interoperable, not a near-duplicate, not on CRAN). It's the decision that matters most in a review and the only one with no checkbox.
  • New section AI-generated and copied code: disclosure in the issue and attribution in-code, per the chapter 19 policy. Kept separate from the license question, which stays under Third-party code.
  • Unit tests: split into presence, quality (tests that assert known values and edge cases rather than just "runs without error"), and no network / no broad skip_on_bioc(). Tautological tests are the failure mode we're seeing most in agent-written submissions.
  • Man pages: examples must actually execute on the builder. BiocCheck already errors below 80% and treats \dontrun and \donttest as no example; @examplesIf interactive() has the same effect and nothing catches it. Also one line saying internal functions need @noRd, not more documentation.
  • Package data: a Hub-based data packages subsection (metadata.csv, make-data.R, make-metadata.R, resources resolvable before review), and the license-of-downloaded-resource bullet made concrete.
  • Vignette: no unconditional downloads in vignettes or tests, so the build system stays within its time limit.
  • R code: constructor, validity, show() per exported class, and results that print something useful.

Changed

  • The web-resources link pointed at the retired bioconductor.org/developers/how-to/web-query/; now the appendix on contributions.bioconductor.org, with tools::R_user_dir() named alongside BiocFileCache.
  • Version: says 0.99.z for new submissions.
  • Sweave note mentions Quarto and its SystemRequirements entry.
  • Removed the two "No warnings or errors in R CMD check / BiocCheck" bullets under R code; they duplicate General.
  • The coding-and-syntax sub-bullets that BiocCheck checks mechanically are tagged "(checked by BiocCheck)", so a reviewer's 30 to 90 minutes go to the judgement items.

Not in this PR, for discussion: a two-tier layout or severity tag per bullet, so fnd, ORCID and README are not at the same level as license and Remotes. That's a bigger reorganisation and I'd rather hear whether people want it first.

Version bumped to 2.1.0.

Drafted with Claude Code (Claude Fable 5.1); decisions and edits are mine.

…xecutable examples, Hub data packages; fix stale link and duplicates

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings September 22, 2026 22:08

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Unresolved checklist alignment and documentation issues remain.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 2 Medium severity · 2 Low severity

Open (4)
What changed in this PR

Updates the Bioconductor package review checklist to version 2.1.0 and align it with current guidance.

Changes:

  • Adds scope, AI disclosure, test quality, executable examples, Hub data, and class criteria.
  • Clarifies versioning, caching, Quarto, vignettes, and BiocCheck guidance.
  • Updates links and removes selected duplicate checks.
File Description
docs/​package-review-checklist.md Expands and revises package review criteria.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +195 to 197
- [ ] Web resources follow the guideline [Querying Web Resources](https://contributions.bioconductor.org/querying-web-resources.html); downloads are cached with `BiocFileCache` or `tools::R_user_dir(pkg, "cache")`.
- [ ] Parallelisation uses `BiocParallel`.
- [ ] Downloaded files cached with `BiocFileCache`.

## AI-generated and copied code

- [ ] Non-trivial AI-generated or copied code is disclosed in the submission issue and attributed in-code (a co-author trailer, or an `Assisted-by:` / `Code copied from:` line), per the [AI and third-party code policy](https://contributions.bioconductor.org/ai-policy-third-party.html).
- [ ] `Package` field.
- [ ] `Title` field.
- [ ] `Version` field.
- [ ] `Version` field. `0.99.z` for a new submission; odd `y` in devel and even `y` in release thereafter.
- no `browser()` in any internal code.
- no `<<-`.
- `is()` instead of `class()` (checked by `BiocCheck`).
- `system2` instead of `system`. And calls are appropriate and safe (checked by `BiocCheck`).

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants