use_bcgov_git: Initialise a Git repository, with bcgov GitHub requirements

View source: R/use.R

use_bcgov_gitR Documentation

Initialise a Git repository, with bcgov GitHub requirements

Description

Initialise a Git repository, with bcgov GitHub requirements

Usage

use_bcgov_git(
  rmarkdown = TRUE,
  licence = "apache2",
  coc_email = get_coc_email(),
  message = "Initial commit"
)

Arguments

rmarkdown

Should an Rmarkdown file be added to the repository with its corresponding markdown file? Default FALSE.

licence

Which licence to apply? Default is Apache 2.0 ("apache2"). Use "cc-by" for Creative Commons Attribution 4.0

coc_email

Contact email address(es) for the Code of Conduct. It is recommended that you save this setting by adding a line like: options("bcgovr.coc.email" = "your.email@gov.bc.ca") to your .Rprofile. Use usethis::edit_r_profile() for an easy way to find and edit this file.

message

git commit message


bcgov/bcgovr documentation built on Sept. 26, 2024, 10:15 a.m.