|
| 1 | +# Contributing to haven |
| 2 | + |
| 3 | +This outlines how to propose a change to haven. |
| 4 | +For more detailed info about contributing to this, and other tidyverse packages, please see the |
| 5 | +[**development contributing guide**](https://rstd.io/tidy-contrib). |
| 6 | + |
| 7 | +## Fixing typos |
| 8 | + |
| 9 | +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. |
| 10 | +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. |
| 11 | +You can find the `.R` file that generates the `.Rd` by reading the comment in the first line. |
| 12 | + |
| 13 | +## Bigger changes |
| 14 | + |
| 15 | +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. |
| 16 | +If you’ve found a bug, please file an issue that illustrates the bug with a minimal |
| 17 | +[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed). |
| 18 | + |
| 19 | +### Pull request process |
| 20 | + |
| 21 | +* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("batpigandme/haven", fork = TRUE)`. |
| 22 | + |
| 23 | +* Install all development dependences with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`. |
| 24 | + If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. |
| 25 | +* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. |
| 26 | + |
| 27 | +* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser. |
| 28 | + The title of your PR should briefly describe the change. |
| 29 | + The body of your PR should contain `Fixes #issue-number`. |
| 30 | + |
| 31 | +* 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>. |
| 32 | + |
| 33 | +### Code style |
| 34 | + |
| 35 | +* New code should follow the tidyverse [style guide](https://style.tidyverse.org). |
| 36 | + 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. |
| 37 | + |
| 38 | +* 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. |
| 39 | + |
| 40 | +* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests. |
| 41 | + Contributions with test cases included are easier to accept. |
| 42 | + |
| 43 | +## Code of Conduct |
| 44 | + |
| 45 | +Please note that the haven project is released with a |
| 46 | +[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this |
| 47 | +project you agree to abide by its terms. |
0 commit comments