Skip to contents

Contributing to codecheck

Source: CONTRIBUTING.md

This document outlines how to request, propose, or implement a change to codecheck.

Fixing Typos

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 file, not the corresponding .Rd file in the man/ directory.

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 reproducible example.

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("codecheckers/codecheck", 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().

  • Create a Git branch for your pull request (PR). We recommend using usethis::pr_init("brief-description-of-change").

  • 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 header). Follow the style described in https://style.tidyverse.org/news.html.

Code Style

  • New code should follow the tidyverse style guide.

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

  • We use tinytest for unit testing. Contributions with test cases included are easier to accept. Run tests using tinytest::test_all(".") from the package root, or tinytest::build_install_test(".") for testing in a fresh environment.

Code of Conduct

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