Add contributors to README.Rmd
add_contributors( repo = ".", ncols = 7, files = c("README.Rmd", "README.md"), type = c("code", "issues", "discussion"), num_sections = 3, section_names = c("Code", "Issue Authors", "Issue Contributors"), format = "grid", alphabetical = FALSE, open_issue = FALSE, force_update = FALSE )
repo | Location of repository for which contributions are to be extracted. This must be a git project with a github remote. |
---|---|
ncols | Number of columns for contributors in 'README' |
files | Names of files in which to add contributors |
type | Type of contributions to include: 'code' for direct code contributions (including documentation), 'issues' to recognise contributors who open issues, and 'discussion' for contributing to discussions within issues. Discussion contributions are only from individuals not present in either 'issues' or 'code'; and 'issues' contributions are only from individuals not present in 'code'. |
num_sections | Number of sections in which to divide contributors:
|
section_names | Names of the sections to appear on the nominated
|
format | One of ("grid", "list", "text") to control display of contributors as
|
alphabetical | If |
open_issue | If |
force_update | If |
Named list of logical values indicating whether files of given names were updated or not is returned invisibly (that is, only if explicitly assigned to a return value).
Opening an issue on github requires the github command-line interface to be locally installed. See https://cli.github.com/.
# The following code extracts the contributors from the git repository # associated with current working directory and writes them to a file. if (FALSE) { f <- tempfile (fileext = ".Rmd") writeLines ("", f) # blank file in tempdir() add_contributors (repo = ".", files = f) }