use_code_of_conduct: Add a code of conduct
In r-lib/usethis: Automate Package and Project Setup
View source: R/code-of-conduct.R
use_code_of_conduct R Documentation
Add a code of conduct
Description
Adds a CODE_OF_CONDUCT.md file to the active project and lists in
.Rbuildignore, in the case of a package. The goal of a code of conduct is
to foster an environment of inclusiveness, and to explicitly discourage
inappropriate behaviour. The template comes from
https://www.contributor-covenant.org, version 2.1:
https://www.contributor-covenant.org/version/2/1/code_of_conduct/.
Usage
use_code_of_conduct(contact, path = NULL)
Arguments
contact
Contact details for making a code of conduct report.
Usually an email address.
path
Path of the directory to put CODE_OF_CONDUCT.md in, relative to
the active project. Passed along to use_directory(). Default is to locate
at top-level, but .github/ is also common.
Details
If your package is going to CRAN, the link to the CoC in your README must
be an absolute link to a rendered website as CODE_OF_CONDUCT.md is not
included in the package sent to CRAN. use_code_of_conduct() will
automatically generate this link if (1) you use pkgdown and (2) have set the
url field in _pkgdown.yml; otherwise it will link to a copy of the CoC
on https://www.contributor-covenant.org.
r-lib/usethis documentation built on Nov. 28, 2024, 7:11 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/code-of-conduct.R
| use_code_of_conduct | R Documentation |
Add a code of conduct
Description
Adds a CODE_OF_CONDUCT.md file to the active project and lists in
.Rbuildignore, in the case of a package. The goal of a code of conduct is
to foster an environment of inclusiveness, and to explicitly discourage
inappropriate behaviour. The template comes from
https://www.contributor-covenant.org, version 2.1:
https://www.contributor-covenant.org/version/2/1/code_of_conduct/.
Usage
use_code_of_conduct(contact, path = NULL)
Arguments
contact |
Contact details for making a code of conduct report. Usually an email address. |
path |
Path of the directory to put |
Details
If your package is going to CRAN, the link to the CoC in your README must
be an absolute link to a rendered website as CODE_OF_CONDUCT.md is not
included in the package sent to CRAN. use_code_of_conduct() will
automatically generate this link if (1) you use pkgdown and (2) have set the
url field in _pkgdown.yml; otherwise it will link to a copy of the CoC
on https://www.contributor-covenant.org.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.