Skip to contents

CONTRIBUTING

Source: .github/CONTRIBUTING.md

Fixing typos

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.

  • YES: you edit a roxygen comment in a .R file below R/.
  • NO: you should not edit an .Rd file below man/.

Prerequisites

Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it’s a problem. If you’ve found a bug, create an associated issue and illustrate the bug with a minimal reprex.

Pull request process

  • We are using the Git commit workflow found here: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow
  • We recommend that you create a Git branch for each pull request (PR) and keep issues addressed to one issue per branch.
  • Look at the git workflow checks before and after making changes. The README should contain badges for any continuous integration services used by the package.
  • We recommend the tidyverse style guide. You can use the styler package to apply these styles, but please don’t restyle code that has nothing to do with your PR.
  • We use roxygen2.
  • We use testthat. Contributions with test cases included are easier to accept.
  • For user-facing changes, add a bullet to the top of NEWS.md below the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).

Code of Conduct

Please note that the DataPackageR project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.

See rOpenSci contributing guide

for further details.

Style pointers for vignettes

  • Headings are in sentence case and contain a period at the end of the heading when appropriate.
  • Conjunctions are excluded from text.
  • Multiline function calls use the following whitespace schema:
myFunction <- aFunctionCall(
  input1 = "this",
  input2 = "that"
)
  • Vignette file names are snake cased with capital first letters: Like_This.Rmd
  • Vignette VignetteIndexEntry are in sentence case: My new vignette

Discussion forum

Check out our discussion forum if you think your issue requires a longer form discussion.

Prefer to Email?

Email the person listed as maintainer in the DESCRIPTION file of this repo.

Though note that private discussions over email don’t help others - of course email is totally warranted if it’s a sensitive problem of any kind.

Thanks for contributing!

This contributing guide is adapted from the tidyverse contributing guide available at https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md