Skip to contents

This outlines how to propose a change to ggsurvfit. For more detailed info about contributing to this, and other tidyverse packages, please see the development contributing guide.

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, 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, please 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).

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("pharmaverse/ggsurvfit", 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.

  • 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 (i.e. just below the first header). Follow the style described in

  • Pull request should include unit testing of the new feature or bug fix.

    • Unit tests will typically include testing using the testthat package, and testing of images (i.e. ggplots) using the vdiffr package.
    • To test the structure of a ggplot object, you have want to first build the plot using ggplot2::ggplot_build(). Then you can programitcally test the contents of the plot.
  • Errors, warnings, and messages are created with cli::cli_abort(), cli::cli_warn(), cli::cli_inform(). We use the convention to first print the error message, then a helpful message when it applies. For example,

    cli::cli_abort(c("!" = "There was an error.",
                     "i" = "a helpful message to resolve error"))

    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 ggsurvfit project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.