urban/data_mining_algorithms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Update README.md

Browse Source
This commit is contained in:
Conrad
2019-07-18 15:30:43 +02:00
committed by GitHub
parent 372bd70df9
commit fe805fa8ce
1 changed files with 5 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -22,17 +22,14 @@ This is a collection of some algorithms and modules we use for data analyses
## How to contribute ## 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) 2. Choose a neat name for it (NAME in the following)
3. Fork this repository (or with rights: add a branch `alg_NAME`) 3. Fork this repository
4. Create subfolder `src/algorithms/NAME` 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 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` 6. Add your algorithm to the list above in the following format `NAME | Author`
7. Create a `readme.md`-file in your main folder 7. Create a pull request to merge the data (if your algorithm works)
8. Create a pull request to merge the data (if your algorithm works)
**Pay attention: NEVER commit test data, passwords or personal information!** **Pay attention: Please don't commit test data. NEVER commit passwords or personal information!**
Have fun... :)
~ ~