|
1 |
| -# Contributing to ezcox |
2 |
| - |
3 |
| -This outlines how to propose a change to ezcox. For more detailed |
4 |
| -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 |
| -Small typos or grammatical errors in documentation may be edited directly using |
10 |
| -the GitHub web interface, so long as the changes are made in the _source_ file. |
11 |
| - |
12 |
| -* YES: you edit a roxygen comment in a `.R` file below `R/`. |
13 |
| -* NO: you edit an `.Rd` file below `man/`. |
14 |
| - |
15 |
| -### Prerequisites |
16 |
| - |
17 |
| -Before you make a substantial pull request, you should always file an issue and |
18 |
| -make sure someone from the team agrees that it’s a problem. If you’ve found a |
19 |
| -bug, create an associated issue and illustrate the bug with a minimal |
20 |
| -[reprex](https://www.tidyverse.org/help/#reprex). |
21 |
| - |
22 |
| -### Pull request process |
23 |
| - |
24 |
| -* We recommend that you create a Git branch for each pull request (PR). |
25 |
| -* Look at the Travis and AppVeyor build status before and after making changes. |
26 |
| -The `README` should contain badges for any continuous integration services used |
27 |
| -by the package. |
28 |
| -* New code should follow the tidyverse [style guide](https://style.tidyverse.org). |
29 |
| -You can use the [styler](https://CRAN.R-project.org/package=styler) package to |
30 |
| -apply these styles, but please don't restyle code that has nothing to do with |
31 |
| -your PR. |
32 |
| -* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with |
33 |
| -[Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html), |
34 |
| -for documentation. |
35 |
| -* We use [testthat](https://cran.r-project.org/package=testthat). Contributions |
36 |
| -with test cases included are easier to accept. |
37 |
| -* For user-facing changes, add a bullet to the top of `NEWS.md` below the |
38 |
| -current development version header describing the changes made followed by your |
39 |
| -GitHub username, and links to relevant issue(s)/PR(s). |
40 |
| - |
41 |
| -### Code of Conduct |
42 |
| - |
43 |
| -Please note that the ezcox project is released with a |
44 |
| -[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this |
45 |
| -project you agree to abide by its terms. |
46 |
| - |
47 |
| -### See tidyverse [development contributing guide](https://rstd.io/tidy-contrib) |
48 |
| -for further details. |
| 1 | +# Contributing to ezcox |
| 2 | + |
| 3 | +This outlines how to propose a change to ezcox. For more detailed |
| 4 | +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 | +Small typos or grammatical errors in documentation may be edited directly using |
| 10 | +the GitHub web interface, so long as the changes are made in the _source_ file. |
| 11 | + |
| 12 | +* YES: you edit a roxygen comment in a `.R` file below `R/`. |
| 13 | +* NO: you edit an `.Rd` file below `man/`. |
| 14 | + |
| 15 | +### Prerequisites |
| 16 | + |
| 17 | +Before you make a substantial pull request, you should always file an issue and |
| 18 | +make sure someone from the team agrees that it’s a problem. If you’ve found a |
| 19 | +bug, create an associated issue and illustrate the bug with a minimal |
| 20 | +[reprex](https://www.tidyverse.org/help/#reprex). |
| 21 | + |
| 22 | +### Pull request process |
| 23 | + |
| 24 | +* We recommend that you create a Git branch for each pull request (PR). |
| 25 | +* Look at the Travis and AppVeyor build status before and after making changes. |
| 26 | +The `README` should contain badges for any continuous integration services used |
| 27 | +by the package. |
| 28 | +* New code should follow the tidyverse [style guide](https://style.tidyverse.org). |
| 29 | +You can use the [styler](https://CRAN.R-project.org/package=styler) package to |
| 30 | +apply these styles, but please don't restyle code that has nothing to do with |
| 31 | +your PR. |
| 32 | +* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with |
| 33 | +[Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html), |
| 34 | +for documentation. |
| 35 | +* We use [testthat](https://cran.r-project.org/package=testthat). Contributions |
| 36 | +with test cases included are easier to accept. |
| 37 | +* For user-facing changes, add a bullet to the top of `NEWS.md` below the |
| 38 | +current development version header describing the changes made followed by your |
| 39 | +GitHub username, and links to relevant issue(s)/PR(s). |
| 40 | + |
| 41 | +### Code of Conduct |
| 42 | + |
| 43 | +Please note that the ezcox project is released with a |
| 44 | +[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this |
| 45 | +project you agree to abide by its terms. |
| 46 | + |
| 47 | +### See tidyverse [development contributing guide](https://rstd.io/tidy-contrib) |
| 48 | +for further details. |
0 commit comments