From 64565433b48bd9a57f8a729b0db56a5049fa96e4 Mon Sep 17 00:00:00 2001 From: Andree Valle Campos Date: Thu, 6 Jun 2024 18:21:25 +0100 Subject: [PATCH] add style decision to the contributing guide --- .github/CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 6555467..63d6e82 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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 `` with `dplyr::as_tibble()` or `head()`.