update_contributing: Update 'CONTRIBUTING.md'

In PetterHopp/NVIpackager: Tools to facilitate Development of NVIverse Packages

Update CONTRIBUTING.md

Description

Update CONTRIBUTING.md and the vignette "Contribute_to_NVIpkg.Rmd" from the template in NVIpackager. If the files don't exist, they are created.

Usage

update_contributing(
  pkg = stringi::stri_extract_last_words(usethis::proj_path()),
  pkg_path = usethis::proj_path()
)

Arguments

pkg	[character(1)] The package name. Defaults to stringi::stri_extract_last_words(usethis::proj_path()).
pkg_path	[character(1)] The path to the package directory. Defaults to usethis::proj_path().

Details

The template is found in NVIpackager. Any change in the text must be done in the template.

Value

None. Writes the vignette "Contribute_to_NVIpkg.Rmd" and the file CONTRIBUTING.md.

Author(s)

Petter Hopp [e-mail]

Examples

## Not run: 
# Attach packages and set up with temporary directory
library(NVIpackager)
td <- tempdir()
if (!dir.exists(file.path(td, "NVItest"))) {
  dir.create(file.path(td, "NVItest"))
}
if (!dir.exists(file.path(td, "NVItest", "vignettes"))) {
  dir.create(file.path(td, "NVItest", "vignettes"))
}

use_contributing(pkg = "NVItest",
                 pkg_path = file.path(td, "NVItest"))

## End(Not run)

PetterHopp/NVIpackager documentation built on Sept. 14, 2024, 1:24 a.m.