R/cran.R

Defines functions use_cran_comments

Documented in use_cran_comments

#' CRAN submission comments
#'
#' Creates `cran-comments.md`, a template for your communications with CRAN when
#' submitting a package. The goal is to clearly communicate the steps you have
#' taken to check your package on a wide range of operating systems. If you are
#' submitting an update to a package that is used by other packages, you also
#' need to summarize the results of your [reverse dependency
#' checks][use_revdep].
#'
#' @export
#' @inheritParams use_template
use_cran_comments <- function(open = rlang::is_interactive()) {
  check_is_package("use_cran_comments()")
  use_template(
    "cran-comments.md",
    ignore = TRUE,
    open = open
  )
}
r-lib/usethis documentation built on March 20, 2024, 8:51 p.m.