-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,50 @@ | ||
| # Contributing to hubEvals | ||
|
|
||
| This outlines how to propose a change to `hubEvals`. | ||
| This outlines how to propose a change to `hubEvals`. | ||
| For more general info about contributing to this, and other hubverse packages, please see the | ||
| [**hubverse contributing guide**](https://hubverse.io/en/latest/overview/contribute.html). | ||
| [**hubverse contributing guide**](https://hubverse.io/en/latest/overview/contribute.html). | ||
|
|
||
| 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 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. | ||
|
|
||
| ## 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 | ||
| 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). | ||
|
|
||
| Our procedures for contributing bigger changes, code in particular, generally follow those advised by the tidyverse dev team, including following the tidyverse style guide for code and recording user facing changes in `NEWS.md`. | ||
|
|
||
| ### 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("Infectious-Disease-Modeling-Hubs/hubEvals", fork = TRUE)`. | ||
| - Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("Infectious-Disease-Modeling-Hubs/hubEvals", 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")`. | ||
| - 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. | ||
|
|
||
| * 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`. | ||
| - Follow [the pull request checklist](https://hubverse-org.github.io/hubDevs/articles/release-checklists.html#subsequent-pr-checklist) to create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("name/brief-description/issue")`. | ||
|
|
||
| * 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>. | ||
| - 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 heading---usually labelled "development version"). Follow the style described in <https://style.tidyverse.org/news.html>. | ||
|
|
||
| ### 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. | ||
| - 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 [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. | ||
| - 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 hubEvals project is released with a | ||
| [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). By contributing to this | ||
| project you agree to abide by its terms. | ||
|
|
||
|
|