You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,22 +3,22 @@
3
3
### Fixing typos
4
4
5
5
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.
6
-
E.g. edit a roxygen comment in a `.R` file below `R/`, not in an `.Rd` file below `man/`.
6
+
E.g. edit a `roxygen2` comment in a `.R` file below `R/`, not in an `.Rd` file below `man/`.
7
7
8
8
### Prerequisites
9
9
10
10
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.
11
-
If you’ve found a bug, create an associated issue and illustrate the bug with a minimal [reprex](https://www.tidyverse.org/help/#reprex).
11
+
If you’ve found a bug, create an associated issue and illustrate the bug with a minimal [reproducible example](https://www.tidyverse.org/help/#reprex).
12
12
13
13
### Pull request process
14
14
15
15
* We recommend that you create a Git branch for each pull request (PR).
16
16
* Look at the GitHub Actions build status before and after making changes.
17
17
The `README` should contain badges for any continuous integration services used by the package.
18
-
* We require the tidyverse [style guide](http://style.tidyverse.org).
19
-
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.
20
-
* We use [roxygen2](https://cran.r-project.org/package=roxygen2).
21
-
* We use [testthat](https://cran.r-project.org/package=testthat).
18
+
* We require the `tidyverse`[style guide](http://style.tidyverse.org).
19
+
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.
20
+
* We use [`roxygen2`](https://cran.r-project.org/package=roxygen2).
21
+
* We use [`testthat`](https://cran.r-project.org/package=testthat).
22
22
Contributions with test cases included are easier to accept.
23
23
* 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).
24
24
@@ -36,4 +36,4 @@ email is totally warranted if it's a sensitive problem of any kind.
36
36
37
37
### Thanks for contributing!
38
38
39
-
This contributing guide is adapted from the tidyverse contributing guide available at https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md
39
+
This contributing guide is adapted from the `tidyverse` contributing guide available at https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md
0 commit comments