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
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,22 @@ For a detailed discussion on contributing to this and other tidyverse packages,
5
5
6
6
## Fixing typos
7
7
8
-
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.
9
-
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.
8
+
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.
9
+
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.
10
10
You can find the `.R` file that generates the `.Rd` by reading the comment in the first line.
11
11
12
12
## Bigger changes
13
13
14
-
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.
15
-
If you’ve found a bug, please file an issue that illustrates the bug with a minimal
14
+
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.
15
+
If you’ve found a bug, please file an issue that illustrates the bug with a minimal
16
16
[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed).
17
17
See our guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice.
18
18
19
19
### Pull request process
20
20
21
21
* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("tidyverse/duckplyr", fork = TRUE)`.
22
22
23
-
* Install all development dependencies with `pak::pak()`, and then make sure the package passes R CMD check by running `devtools::check()`.
23
+
* Install all development dependencies with `pak::pak()`, and then make sure the package passes R CMD check by running `devtools::check()`.
24
24
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
25
25
26
26
* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`.
@@ -33,13 +33,13 @@ See our guide on [how to create a great issue](https://code-review.tidyverse.org
33
33
34
34
### Code style
35
35
36
-
* New code should follow the tidyverse [style guide](https://style.tidyverse.org).
37
-
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.
36
+
* New code should follow the tidyverse [style guide](https://style.tidyverse.org).
37
+
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.
38
38
39
-
* 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.
39
+
* 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.
40
40
41
-
* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests.
42
-
Contributions with test cases included are easier to accept.
41
+
* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests.
42
+
Contributions with test cases included are easier to accept.
0 commit comments