Skip to contents

Contributing to hubExamples

Source: .github/CONTRIBUTING.md

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

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 contributing 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.

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/hubExamples", 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.

  • If you’re changing the scripts in data-raw/, you can run tests locally: devtools::test() (because the contents of data-raw are not included in the package, these tests are skipped during R checks).

Code style

  • New code should follow the tidyverse style guide. We use Air for code formatting.

  • We use roxygen2, with Markdown syntax, for documentation.

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

Setting up Air

The project contains configuration files (air.toml, .vscode/) that ensure formatting is scoped to this repository only—your personal projects remain unaffected.

Positron

Air ships built-in with Positron. The project settings are already configured, so format-on-save is enabled automatically when working in this repo.

VS Code

  1. Install the Air extension
  2. The project settings are already configured, so format-on-save is enabled automatically when working in this repo

RStudio (2024.12.0+)

RStudio requires manual setup. Note that RStudio does not support per-project settings, so these are global options.

  1. Install the Air CLI:
    • macOS/Linux: curl -LsSf https://github.com/posit-dev/air/releases/latest/download/air-installer.sh | sh
    • macOS (Homebrew): brew install air
    • Windows: powershell -ExecutionPolicy Bypass -c "irm https://github.com/posit-dev/air/releases/latest/download/air-installer.ps1 | iex"
  2. In RStudio, go to Tools > Global Options > Code > Formatting and:
    • Check “Use external formatter”
    • Set “Reformat command:” to {path/to/air} format (find the path with which air on macOS/Linux)
    • See the RStudio setup guide for more details
  3. Optionally, enable format-on-save globally:
    • In the same settings pane, check “Format code on save”
    • Note: This applies to all projects, not just hubverse repos
  4. If you prefer not to enable format-on-save globally, format manually before committing:
    • Use Code > Reformat Code (Cmd/Ctrl+Shift+A) or right-click and select “Reformat Code”
    • CI will check formatting on PRs and fail if code is not formatted

Command Line

Works from any terminal: - Format entire project: air format . - Check without modifying: air format . --check

Code of Conduct

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