Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 3.96 KB
Raw

Contributing to hubValidations

This outlines how to propose a change to hubValidations. For more general info about contributing to this, and other hubverse packages, please see the hubverse contributing guide.

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you'll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment in the first line.

Bigger changes

If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it's needed. If you've found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).

Our procedures for contributed bigger changes, code in particular, generally follow those advised by the tidyverse dev team, including following the tidyverse style guide for code and recording user facing changes in NEWS.md.

Submitting new check functions

If submitting a new check function, please ensure you update inst/check_table.csv with metadata about the check. The file records metadata about check functions, both standard and optional and is used primarily in documentation.

Information required includes:

  • Name of the check (as it will appear in the hub_validations object output by the calling function). This field NA for optional functions as the name is user defined.
  • Description of the check.
  • Whether it will cause the calling function to return early.
  • Whether it returns a <check_error> or <check_warning> class object if the check fails.
  • The calling function it is designed to be called from.
  • Any additional information contained by the function output.
  • Whether the check is optional.

Pull request process

  • Fork the package and clone onto your computer. If you haven't done this before, we recommend using usethis::create_from_github("hubverse-org/hubValidations", fork = TRUE).

  • Install all development dependencies with devtools::install_dev_deps(), and then make sure the package passes R CMD check by running devtools::check(). If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.

  • Follow the pull request checklist to create a Git branch for your pull request (PR). We recommend using usethis::pr_init("name/brief-description/issue").

  • Make your changes, commit to git, and then create a PR by running usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain Fixes #issue-number.

  • For user-facing changes, add a bullet to the top of NEWS.md (i.e. just below the first heading---usually labelled "development version"). Follow the style described in https://style.tidyverse.org/news.html.

Code style

  • New code should follow 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, with Markdown syntax, for documentation.

  • We use testthat for unit tests. Contributions with test cases included are easier to accept.

Code of Conduct

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