Skip to contents

Contributing to gigs

Source: .github/CONTRIBUTING.md

This file outlines how to propose a change to gigs. It is based on the tidyverse contributing guidelines.

Planned development

This package is currently in a stable state of development, with some degree of active subsequent development as envisioned by the primary authors. We plan to add:

  • Additional growth standards if requested by package users and deemed within the package scope

Scope

This package’s scope is limited to international growth standards. As a consequence, feature requests or pull requests which add support for growth references (e.g. the CDC growth charts or UK-WHO growth charts) will be rejected. If you want to use growth references in your work, you may find other packages more useful. The childsds package can work with many references if you wish to use these instead.

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, it’s a good idea to first file an issue and see if a maintainer agrees that it is necessary. 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). You can check out the tidyverse guide on how to create a great issue for more advice.

Pull request process

  • Fork the package and clone onto your computer. If you haven’t done this before, you can use usethis::create_from_github("ropensci/gigs", 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 NEWS.md (i.e. just below the first header). Follow the style described in the tidyverse style guide.

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 existing code which is not altered as part of 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 gigs project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.