R/collaboration_templates.R

In ropenscilabs/rodev: Helper for rOpenSci Package Developpers

# Use issue template
use_issue_template <- function(){
  fs::dir_create(file.path(usethis::proj_get(),
                           ".github"))
  usethis::use_template(template = "issue_template.md",
                        save_as = file.path(".github", "issue_template.md"),
                        package = "rodev")

}

# Use pull request template
use_pull_request_template <- function(){
  fs::dir_create(file.path(usethis::proj_get(),
                           ".github"))
  usethis::use_template(template = "pull_request_template.md",
                        save_as = file.path(".github", "pull_request_template.md"),
                        package = "rodev")

}

# Use CONTRIBUTING template
use_contributing_template <- function(package_name){
  fs::dir_create(file.path(usethis::proj_get(),
                           ".github"))
  usethis::use_template(template = "CONTRIBUTING.md",
                        save_as = file.path(".github", "CONTRIBUTING.md"),
                        package = "rodev",
                        data = list(package = package_name))

}

#' @title Add collaboration files in .github
#'
#' @description Add issue, PR templates and CONTRIBUTING.md file
#' in .github
#'
#' @param package_name Package name
#'
#' @export
use_ro_github <- function(package_name = desc::desc_get_field("Package",
                                                              file = usethis::proj_get())){
  use_issue_template()
  use_pull_request_template()
  use_contributing_template(package_name = package_name)
  usethis::use_build_ignore(".github")
}