From f2ca581db63edfd278a14e54f05dea714cfe3f51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustavo=20Vel=C3=A1squez?= Date: Thu, 24 Mar 2022 23:30:43 -0700 Subject: [PATCH] usethis::use_tidy_contributing() --- .github/CONTRIBUTING.md | 69 ++++++++++++++++++++--------------------- 1 file changed, 34 insertions(+), 35 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b231921..ea92ece 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,48 +1,47 @@ # Contributing to tidytab -This outlines how to propose a change to tidytab. For more detailed -info about contributing to this, and other tidyverse packages, please see the -[**development contributing guide**](https://rstd.io/tidy-contrib). +This outlines how to propose a change to tidytab. +For more detailed info about contributing to this, and other tidyverse packages, please see the +[**development contributing guide**](https://rstd.io/tidy-contrib). -### Fixing typos +## Fixing typos -Small typos or grammatical errors in documentation may be edited directly using -the GitHub web interface, so long as the changes are made in the _source_ file. +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](https://roxygen2.r-lib.org/articles/roxygen2.html) 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. -* YES: you edit a roxygen comment in a `.R` file below `R/`. -* NO: you edit an `.Rd` file below `man/`. +## Bigger changes -### Prerequisites - -Before you make a substantial pull request, you should always file an issue and -make sure someone from the team agrees that it’s a problem. If you’ve found a -bug, create an associated issue and illustrate the bug with a minimal -[reprex](https://www.tidyverse.org/help/#reprex). +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](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed). ### Pull request process -* We recommend that you create a Git branch for each pull request (PR). -* Look at the Travis and AppVeyor build status before and after making changes. -The `README` should contain badges for any continuous integration services used -by the package. -* New code should follow the tidyverse [style guide](http://style.tidyverse.org). -You can use the [styler](https://CRAN.R-project.org/package=styler) package to -apply these styles, but please don't restyle code that has nothing to do with -your PR. -* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with -[Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html), -for documentation. -* We use [testthat](https://cran.r-project.org/package=testthat). Contributions -with test cases included are easier to accept. -* For user-facing changes, add a bullet to the top of `NEWS.md` below the -current development version header describing the changes made followed by your -GitHub username, and links to relevant issue(s)/PR(s). - -### Code of Conduct +* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("gvelasq/tidytab", 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 . + +### Code style + +* New code should follow the tidyverse [style guide](https://style.tidyverse.org). + You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR. + +* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation. + +* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests. + Contributions with test cases included are easier to accept. + +## Code of Conduct Please note that the tidytab project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms. - -### See tidyverse [development contributing guide](https://rstd.io/tidy-contrib) -for further details.