CONTRIBUTING.md

In ropensci-review-tools/pkgcheck: rOpenSci Package Checks

Contributing to pkgcheck

Opening issues

The easiest way to note any behavioural curiosities or to request any new features is by opening a github issue.

Development guidelines

If you'd like to contribute changes to pkgcheck, we use the GitHub flow for proposing, submitting, reviewing, and accepting changes. If you haven't done this before, there's a nice overview of git, as well as best practices for submitting pull requests in the R packages book by Hadley Wickham and Jenny Bryan.

The pkgcheck coding style diverges somewhat from the commonly used tidyverse style guide, primarily through judicious use of whitespace, which aims to improve code readability. Code references in pkgcheck are separated by whitespace, just like words of text. Just like it is easier to understand "these three words" than "thesethreewords", code is not formatted like this:

these <- three(words(x))

rather like this:

these <- three (words (x))

The position of brackets is then arbitrary, and we could also write

these <- three( words (x))

pkgcheck code opts for the former style, with the natural result that one ends up writing

this <- function ()

with a space between function and (). That's it.

Adding new checks

New checks are a welcome contribution to pkgcheck, for which there is a dedicated vignette. Please discuss any proposed new checks by opening an issue on the GitHub repository.

Code of Conduct

We want to encourage a warm, welcoming, and safe environment for contributing to this project. See the code of conduct for more information.

ropensci-review-tools/pkgcheck documentation built on Nov. 24, 2024, 7:57 p.m.