Skip to content

Commit

Permalink
add style decision to the contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
avallecam committed Jun 6, 2024
1 parent 6f776d8 commit 6456543
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,11 @@ Any of these actions needs be done in an isolated PR.
### 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.
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.

* Each howto entry should include __one chunk only__. This aims to be ready to copy and paste as a whole, resembling a reprex. For this reason, the howto entry chunk:
- __Can not__ include intermediate plots. Chunks can only include one plot at the end of the chunk. To compare plots, use the [patchwork](https://patchwork.data-imaginist.com/) R package to add `ggplot` objects together using the `+` operator.
- __Can__ include intermediate output prints. You can avoid long output prints using `<tibbles>` with `dplyr::as_tibble()` or `head()`.

<!--* 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.
Expand Down

0 comments on commit 6456543

Please sign in to comment.