Skip to contents

Helpers for creating community facing hubverse package documents

Source: R/community.R
use_hubdev_community.Rd

These functions create community facing documents detailing how contributors and the wider community can interact with hubverse packages. Each function creates the relevant file in the .github directory from templates and is set up with appropriate hubverse default values.

Usage

use_hubdev_community(
  organisation = "Infectious-Disease-Modeling-Hubs",
  hubdocs_contribute_url =
    "https://hubdocs.readthedocs.io/en/latest/overview/contribute.html"
)

use_hubdev_coc()

use_hubdev_contributing(
  organisation = "Infectious-Disease-Modeling-Hubs",
  hubdocs_contribute_url =
    "https://hubdocs.readthedocs.io/en/latest/overview/contribute.html"
)

Arguments

organisation

Character string. The hubverse GitHub organisation name. The user's role and the token's scopes must be such that you have permission to create repositories in the hubverse organisation.

hubdocs_contribute_url

Character string. URL of the general contributing information page on hubDocs.

Functions

  • use_hubdev_community(): Create hubverse CODE_OF_CONDUCT.md and CONTRIBUTING.md files.

  • use_hubdev_coc(): Create hubverse CODE_OF_CONDUCT.md file.

  • use_hubdev_contributing(): Create hubverse CONTRIBUTING.md file.