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
Conversation
…xecutable examples, Hub data packages; fix stale link and duplicates Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
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
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


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
skip_on_bioc(). Tautological tests are the failure mode we're seeing most in agent-written submissions.\dontrunand\donttestas no example;@examplesIf interactive()has the same effect and nothing catches it. Also one line saying internal functions need@noRd, not more documentation.show()per exported class, and results that print something useful.Changed
bioconductor.org/developers/how-to/web-query/; now the appendix on contributions.bioconductor.org, withtools::R_user_dir()named alongsideBiocFileCache.Version: says0.99.zfor new submissions.SystemRequirementsentry.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.