diff --git a/README.md b/README.md index 717bf0801f846f6035a5a32ab63c2a4a1c88305f..f9cce382008cbb08f2e099f82e6e39d273a94808 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 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 obtained. +7. Let the maintainers know the development is finished to let them finalize the standarization with master branch.