Merge pull request #1 from TheAlgorithms/master

update

Author: Luciker

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: TheAlgorithms
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: ['http://paypal.me/TheAlgorithms/1000', 'https://donorbox.org/thealgorithms']

.lgtm.yml

@@ -1,26 +1,22 @@
 language: python
+dist: xenial  # required for Python >= 3.7
+python: 3.7
 cache: pip
-python:
-    - 2.7
-    - 3.6
-    #- nightly
-    #- pypy
-    #- pypy3
-matrix:
-    allow_failures:
-        - python: nightly
-        - python: pypy
-        - python: pypy3
-install:
-    #- pip install -r requirements.txt
-    - pip install flake8  # pytest  # add another testing frameworks later
+before_install: pip install --upgrade pip setuptools
+install: pip install -r requirements.txt
 before_script:
-    # stop the build if there are Python syntax errors or undefined names
-    - flake8 . --count --select=E9,F63,F72,F82 --show-source --statistics
-    # exit-zero treats all errors as warnings.  The GitHub editor is 127 chars wide
-    - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+  - black --check . || true
+  - flake8 . --count --select=E9,F401,F63,F7,F82 --show-source --statistics
 script:
-    - true  # pytest --capture=sys  # add other tests here
-notifications:
-    on_success: change
-    on_failure: change  # `always` will be the setting once code changes slow down
+  - scripts/validate_filenames.py  # no uppercase and no spaces
+  - mypy --ignore-missing-imports .
+  - pytest . --doctest-modules
+      --ignore=file_transfer_protocol/ftp_send_receive.py
+      --ignore=file_transfer_protocol/ftp_client_server.py
+      --ignore=machine_learning/linear_regression.py
+      --ignore=machine_learning/perceptron.py
+      --ignore=machine_learning/random_forest_classification/random_forest_classification.py
+      --ignore=machine_learning/random_forest_regression/random_forest_regression.py
+after_success:
+  - scripts/build_directory_md.py > DIRECTORY.md
+  - cat DIRECTORY.md

.travis.yml

@@ -28,6 +28,13 @@ We appreciate any contribution, from fixing a grammar mistake in a comment to im
 We want your work to be readable by others; therefore, we encourage you to note the following:
 
 - Please write in Python 3.x.
+- Please consider running [__python/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request.  This is not a requirement but it does make your code more readable.  There are other code formatters (autopep8, yapf) but the __black__ style is now the recommendation of the Python core team. To use it,
+    ```bash
+    pip3 install black  # only required the first time
+    black my-submission.py
+    ```
+
+- All submissions will need to pass the test __flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics__ before they will be accepted so if possible, try this test locally on your Python file(s) before submitting your pull request.
 
 - If you know [PEP 8](https://www.python.org/dev/peps/pep-0008/) already, you will have no problem in coding style, though we do not follow it strictly. Read the remaining section and have fun coding!
 
@@ -62,7 +69,7 @@ We want your work to be readable by others; therefore, we encourage you to note
       """
   	This function sums two integers a and b
   	Return: a + b
-  	"""
+      """
       return a + b
   ```
 
@@ -72,13 +79,19 @@ We want your work to be readable by others; therefore, we encourage you to note
 
 - Write tests to illustrate your work.
 
-  The following "testing" approaches are not encouraged:
+  The following "testing" approaches are **not** encouraged:
 
   ```python
   input('Enter your input:') 
   # Or even worse...
   input = eval(raw_input("Enter your input: "))
   ```
+  
+  However, if your code uses __input()__ then we encourage you to gracefully deal with leading and trailing whitespace in user input by adding __.strip()__ to the end as in:
+  
+  ```python
+  starting_value = int(input("Please enter a starting value: ").strip())
+  ```
 
   Please write down your test case, like the following:
 
@@ -92,30 +105,32 @@ We want your work to be readable by others; therefore, we encourage you to note
   print("1 + 2 = ", sumab(1,2))	# 1+2 = 3
   print("6 + 4 = ", sumab(6,4))	# 6+4 = 10
   ```
+  
+  Better yet, if you know how to write [__doctests__](https://docs.python.org/3/library/doctest.html), please consider adding them.
 
-- Avoid importing external libraries for basic algorithms. Use those libraries for complicated algorithms.
+- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
 
 #### Other Standard While Submitting Your Work
 
-- File extension for code should be `.py`.
+- File extension for code should be `.py`. Jupiter notebook files are acceptable in machine learning algorithms.
 
-- Please file your work to let others use it in the future. Here are the examples that are acceptable:
-
-  - Camel cases
-  - `-` Hyphenated names
-  - `_` Underscore-separated names
+- Strictly use snake case (underscore separated) in your file name, as it will be easy to parse in future using scripts.
 
   If possible, follow the standard *within* the folder you are submitting to.
 
 - If you have modified/added code work, make sure the code compiles before submitting.
 
-- If you have modified/added documentation work, make sure your language is concise and contains no grammar mistake.
+- If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
+
+- Do not update the README.md or DIRECTORY.md file which will be periodically autogenerated by our Travis CI processes.
 
 - Add a corresponding explanation to [Algorithms-Explanation](https://github.com/TheAlgorithms/Algorithms-Explanation) (Optional but recommended).
 
+- All submissions will be tested with [__mypy__](http://www.mypy-lang.org) so we encourage to add [__Python type hints__](https://docs.python.org/3/library/typing.html) where it makes sense to do so.
+
 - Most importantly,
 
-  - **Be consistent with this guidelines while submitting.**
+  - **Be consistent in the use of these guidelines when submitting.**
   - **Join** [Gitter](https://gitter.im/TheAlgorithms) **now!**
   - Happy coding!