From 9b986435fb92106879a220e0c2031bf7b4a8d158 Mon Sep 17 00:00:00 2001 From: ARIADNA BATALLA FERRES Date: Wed, 11 Dec 2024 14:10:01 +0100 Subject: [PATCH 1/4] Add CONTRIBUTING.md --- CONTRIBUTING.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6d5e97f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +### Questions and bug reports + +If you have questions about the usage of a function or would like to report a bug, please follow these steps: + +1. Use the search function in GitLab to see if a similar problem has already been reported and/or solved. + +2. Rather than including a long script, try to run your code in small blocks to narrow down where the problem is coming from as much as possible. + +3. Open an issue tagging the maintainers (@abatalla), and include a descriptive title and a piece of code to reproduce your problem (if applicable). + +### How to contribute + +If you would like to add a bugfix, an enhancement or a new functions, follow these steps: + +1. Open an issue to ask for help or describe a feature to be integrated + +2. Agree with the maintainers (@vagudets) on the requirements + +3. Create a new branch from master with a meaningful name + +4. Once the development is finished, open a merge request to merge the branch on master + +*Note: Remember to work with multidimensional arrays with named dimensions when possible and use multiApply (https://earth.bsc.es/gitlab/ces/multiApply)* + +### Adding a function + +To add a new function in this R package, follow these considerations: + +* Each function exposed to the users should be in its own separate file in the R folder +* The name of the function should match the name of the file (e.g.: `Function()` included in file **Function.R** +* The documentation should be in roxygen2 format as a header of the function +* Once the function and the documentation are finished, run the command `devtools::document()` in your R terminal to automatically generate the **Function.Rd** file +* When doing the development, please use an R version between R/4.1.2 and R/4.3.x + +### Style guide + +* Use `<-` for variable assignment +* Include spaces between operators (e.g. `+`, `-`, `&`), before `{`, and after `for`, `if`, `while`, `,` and `)`. +* When possible, maximum line length should be 100 characters (soft limit of 80 characters). +* Number of indentation spaces is 2, using tabs for indentation is forbidden. +* Double quotes are recommended for strings. When writing quotes within quoted text, use double quotes outside and single quotes inside. E.g.: `“Parameter 'na.rm' is missing.”` +* Self-explanatory names are preferred for variables. Try to be consistent with the variable naming style. Generally: avoid special characters (except underscores) and reserved words (ex: if, for, else, …) +* Remember to include short comments to make the code easier to understand. Comments should be in their own line and they should start with `#` followed by a space. Comments that start with `##` and a space are for details not needed to understand the general procedure but useful to make note of more technical aspects of the code. + +#### Examples: + +```r +# Proper spacing, indentation spaces and text quotes: +NewFunction <- function(text = "default", uppercase = TRUE) { + # Check uppercase parameter + if (!is.logical(uppercase)) { + stop("Parameter 'uppercase' should be TRUE or FALSE.") + } + # Only transform text if needed + if (uppercase && is.character(text)) { + text <- toupper(text) + } + return(text) +} + +# How to format line breaks to avoid long lines: +my_strings <- list(one = "one", + two = "two", + three = "three", + four = "four") +``` -- GitLab From c50faca488094ec226f6e7ba17127688293d083a Mon Sep 17 00:00:00 2001 From: ARIADNA BATALLA FERRES Date: Thu, 2 Jan 2025 11:52:08 +0100 Subject: [PATCH 2/4] Add link to CONTRIBUTING.md in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5929f90..10c93ae 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,10 @@ The plotting functions, with a name starting with `Viz*`, can be categorized int Bug Report ---------- -If you find any bug or have any question, please open an issue and tag the maintainers (@aho) (@erifarov), +If you find any bug or have any question, please open an issue and tag the maintainers (@abatalla), and follow the issue template to provide the necessary details. Contribution ---------- -Your suggestion or contribution to this package is very welcomed. Please open an issue and tag the maintainers (@aho) (@erifarov) to discuss the details. +Your suggestion or contribution to this package is very welcomed. For more information on how to contribute, please refer to the [**CONTRIBUTING.md**](CONTRIBUTING.md) file. -- GitLab From 2713fa1fea9a3d05dd334dd7facd1a4124059729 Mon Sep 17 00:00:00 2001 From: ARIADNA BATALLA FERRES Date: Thu, 2 Jan 2025 11:54:19 +0100 Subject: [PATCH 3/4] Fix README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 10c93ae..93ff310 100644 --- a/README.md +++ b/README.md @@ -27,5 +27,5 @@ and follow the issue template to provide the necessary details. Contribution ---------- -Your suggestion or contribution to this package is very welcomed. For more information on how to contribute, please refer to the [**CONTRIBUTING.md**](CONTRIBUTING.md) file. +Your suggestion or contribution to this package is very welcomed. For information on how to contribute, please refer to the [**CONTRIBUTING.md**](CONTRIBUTING.md) file. -- GitLab From 8b18f9bfc35b316f50a10de7d7983ea9e5baeb08 Mon Sep 17 00:00:00 2001 From: ARIADNA BATALLA FERRES Date: Thu, 9 Jan 2025 17:30:18 +0100 Subject: [PATCH 4/4] update maintainer --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d5e97f..87a8cec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ If you would like to add a bugfix, an enhancement or a new functions, follow the 1. Open an issue to ask for help or describe a feature to be integrated -2. Agree with the maintainers (@vagudets) on the requirements +2. Agree with the maintainers (@abatalla) on the requirements 3. Create a new branch from master with a meaningful name -- GitLab