CONTRIBUTING.md

Contributing

Requirements

install.packages(c('httptest', 'testthat', 'mockthat', 'getPass', 'rstudioapi', 'mockery', 'lintr', 'styler', 'devtools', 'roxygen2'))

Development

This project follows the tidyverse style guide and uses roxygen2 for generating documentation.

External functions need an @export tag in the Roxygen2 docstring. They must also be added to _pkgdown.yml.

After adding a new function, you must:

library('roxygen2')
roxygenise()

Markdown

Roxygen has markdown support. To enable it, include the @md tag in the docstring, i.e.:

#' @param properties list Properties 
#'
#' Accepted properties:
#' - item type Description of item
#' - itemList list List with properties:
#'   - property character
#'   - property character
#' @md