From f54471151a9ab2f5e1ba9f62ce0dfdea4757e9fd Mon Sep 17 00:00:00 2001 From: Russ Thomas Date: Fri, 19 Sep 2025 12:21:36 -0400 Subject: [PATCH] Fixes #1862 --- R/upkeep.R | 37 ++++++++++++++++++++++++++++++++++++ man/use_upkeep_issue.Rd | 42 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+) diff --git a/R/upkeep.R b/R/upkeep.R index b6e64517c..f9a8a8058 100644 --- a/R/upkeep.R +++ b/R/upkeep.R @@ -10,6 +10,43 @@ #' tidyverse team uses a similar function [use_tidy_upkeep_issue()] for our #' annual package Spring Cleaning. #' +#' @details +#' The following checklist will be created. Please note that some checklist +#' items may not apply to your specific package. +#' +#' +#' * usethis::use_readme_rmd() +#' * usethis::use_roxygen_md() +#' * usethis::use_github_links() +#' * usethis::use_pkgdown_github_pages() +#' * Consider using Bootstrap 5 in your pkgdown site. +#' + See for more info +#' * usethis::use_tidy_description() +#' * usethis::use_tidy_description() +#' + Consider letting usethis manage your `@importFrom` directives here. +#' + usethis::use_import_from() is handy for this. +#' * usethis::use_testthat() +#' * usethis::use_testthat(3) +#' * Align the names of `R/` files and `test/` files for workflow happiness. +#' + The docs for `usethis::use_r()` include a helpful script. +#' + usethis::rename_files() may be be useful. +#' * Consider changing default branch from `master` to `main` +#' * usethis::use_code_of_conduct() +#' * Remove description of test environments from cran-comments.md +#' + See usethis::use_cran_comments() +#' * Add alt-text to pictures, plots, etc +#' + see for examples +#' + Set up or update GitHub Actions. +#' + Updating workflows to the latest version will often fix troublesome actions +#' * usethis::use_github_action('check-standard') +#' * usethis::use_github_action('pkgdown') +#' * usethis::use_github_action('test-coverage') +#' +#' +#' +#' +#' +#' #' @param year Year you are performing the upkeep, used in the issue title. #' Defaults to current year #' diff --git a/man/use_upkeep_issue.Rd b/man/use_upkeep_issue.Rd index a916dafa0..de2b5b9e9 100644 --- a/man/use_upkeep_issue.Rd +++ b/man/use_upkeep_issue.Rd @@ -20,6 +20,48 @@ up in subsequent lists), and some should be reviewed periodically. The tidyverse team uses a similar function \code{\link[=use_tidy_upkeep_issue]{use_tidy_upkeep_issue()}} for our annual package Spring Cleaning. } +\details{ +The following checklist will be created. Please note that some checklist +items may not apply to your specific package. +\itemize{ +\item usethis::use_readme_rmd() +\item usethis::use_roxygen_md() +\item usethis::use_github_links() +\item usethis::use_pkgdown_github_pages() +\item Consider using Bootstrap 5 in your pkgdown site. +\itemize{ +\item See \url{https://pkgdown.r-lib.org/articles/customise.html} for more info +} +\item usethis::use_tidy_description() +\item usethis::use_tidy_description() +\itemize{ +\item Consider letting usethis manage your \verb{@importFrom} directives here. +\item usethis::use_import_from() is handy for this. +} +\item usethis::use_testthat() +\item usethis::use_testthat(3) +\item Align the names of \verb{R/} files and \verb{test/} files for workflow happiness. +\itemize{ +\item The docs for \code{usethis::use_r()} include a helpful script. +\item usethis::rename_files() may be be useful. +} +\item Consider changing default branch from \code{master} to \code{main} +\item usethis::use_code_of_conduct() +\item Remove description of test environments from cran-comments.md +\itemize{ +\item See usethis::use_cran_comments() +} +\item Add alt-text to pictures, plots, etc +\itemize{ +\item see \url{https://posit.co/blog/knitr-fig-alt/} for examples +\item Set up or update GitHub Actions. +\item Updating workflows to the latest version will often fix troublesome actions +} +\item usethis::use_github_action('check-standard') +\item usethis::use_github_action('pkgdown') +\item usethis::use_github_action('test-coverage') +} +} \examples{ \dontrun{ use_upkeep_issue()