-
Notifications
You must be signed in to change notification settings - Fork 289
Description
Summary
The current cran-comments.md
template provided by usethis
focuses heavily on reporting R CMD check results, which CRAN maintainers don't rely on as they run their own checks. This issue proposes a revised template that focuses on information CRAN maintainers have specifically requested and find actionable during the review process.
Current issues
The current template emphasizes R CMD check
results for a new package:
0 errors | 0 warnings | 1 note |
However, based on feedback from CRAN maintainers and experiences with submission processes like devtools::release()
or a Github Action workflow, the most common issues flagged during review are:
- Unanswered questions from previous submissions
- Lack of justification for rapid resubmissions
- Insufficient information about breaking changes to reverse dependencies
Proposed template change
Replace the current template with one that directly addresses these key concerns:
## Package Submission
* Submission type: [initial/update/resubmission]
## Response to Previous CRAN Feedback
[Direct responses to each point raised in previous submissions]
## Urgency Justification (if applicable)
[Explain why this update is urgent, if submitted soon after previous version]
## Reverse Dependency Impact
* Breaking changes: [Yes/No]
* If Yes:
* Affected packages: [list]
* Maintainers notified: [When, response summary]
## Additional Information
[Any other relevant details requested by CRAN maintainers or useful to them]
This change requires updating the template file at inst/templates/cran-comments.md
in the usethis package.