From f74dbfedd03757effda82bc10dd39ff57de59d85 Mon Sep 17 00:00:00 2001 From: nperez Date: Fri, 19 Jun 2020 19:14:52 +0200 Subject: [PATCH 1/2] Review of README with how to contribute --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 717bf08..b03eb90 100644 --- a/README.md +++ b/README.md @@ -65,4 +65,17 @@ correlation with reliability indicators such as p-values and confidence interval results obtained from any of the modules above. +Contribute +---------- +If you have a function to share in this package of do you want to improve a function, your contribution will be very welcomed to the package. + +Please, in order to achieve our goal, follow these steps: + +1. Open an issue to contact the maintainer and agree in the suitability of your development in the package. +2. Create a branch with a identificative name: starting by 'develop-' and followed by a word releated to the development (e.g.: 'develop-Persistance' for function Persistance) +3. Add you function to folder R and create the documentation in roxyegen2 format or modify a function in the package following the discussion on the previous issue. +4. Do as many modifications and pushes as needed to achieve the desired result. +5. Open a merge request and tag the maintainers to review the function or to contact an expert to carry the review. +6. Keep working on the modification until the final result is obtain. +7. Let the maintainer know the development is finished to let her finalize the standarization with master branch. -- GitLab From 75ea8295dd35e6043aaadccc146657379157e4a4 Mon Sep 17 00:00:00 2001 From: aho Date: Mon, 22 Jun 2020 09:39:33 +0200 Subject: [PATCH 2/2] Add maintainers' name and fix typo. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b03eb90..f9cce38 100644 --- a/README.md +++ b/README.md @@ -72,10 +72,10 @@ If you have a function to share in this package of do you want to improve a func Please, in order to achieve our goal, follow these steps: -1. Open an issue to contact the maintainer and agree in the suitability of your development in the package. -2. Create a branch with a identificative name: starting by 'develop-' and followed by a word releated to the development (e.g.: 'develop-Persistance' for function Persistance) +1. Open an issue to contact the maintainers (@aho and @nperez) and agree in the suitability of your development in the package. +2. Create a branch with an identificative name: starting by 'develop-' and followed by a word releated to the development (e.g.: 'develop-Persistance' for function Persistance) 3. Add you function to folder R and create the documentation in roxyegen2 format or modify a function in the package following the discussion on the previous issue. 4. Do as many modifications and pushes as needed to achieve the desired result. 5. Open a merge request and tag the maintainers to review the function or to contact an expert to carry the review. -6. Keep working on the modification until the final result is obtain. -7. Let the maintainer know the development is finished to let her finalize the standarization with master branch. +6. Keep working on the modification until the final result is obtained. +7. Let the maintainers know the development is finished to let them finalize the standarization with master branch. -- GitLab