From fe805fa8ce3bf85d2195aaec81581751171da464 Mon Sep 17 00:00:00 2001 From: Conrad Date: Thu, 18 Jul 2019 15:30:43 +0200 Subject: [PATCH] Update README.md --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5490771..ac555ae 100644 --- a/README.md +++ b/README.md @@ -22,17 +22,14 @@ This is a collection of some algorithms and modules we use for data analyses ## How to contribute -1. Write your algorithm (or part of it) +1. Write your algorithm (and test it!) 2. Choose a neat name for it (NAME in the following) -3. Fork this repository (or with rights: add a branch `alg_NAME`) -4. Create subfolder `src/algorithms/NAME` +3. Fork this repository +4. Create subfolder `src/algorithms/NAME` with your algorithm and a `readme.md`-file 5. Add your algorithm to the `menu`-script in the `algorithm`-folder 6. Add your algorithm to the list above in the following format `NAME | Author` -7. Create a `readme.md`-file in your main folder -8. Create a pull request to merge the data (if your algorithm works) +7. Create a pull request to merge the data (if your algorithm works) -**Pay attention: NEVER commit test data, passwords or personal information!** - -Have fun... :) +**Pay attention: Please don't commit test data. NEVER commit passwords or personal information!** ~