mathdatech/Python
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/Python.git synced 2025-01-31 06:33:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#1250)

Browse Source 
* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Add Python type hints and mypy
This commit is contained in:
Christian Clauss 2019-10-02 18:19:00 +02:00 committed by Anup Kumar Panwar
parent b738281f2b
commit df44d1b703
1 changed files with 55 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
CONTRIBUTING.md
View File

@ -23,26 +23,38 @@ We are very happy that you consider implementing algorithms and data structure f
We appreciate any contribution, from fixing a grammar mistake in a comment to implementing complex algorithms. Please read this section if you are contributing your work.
Your contribution will be tested by our [automated testing on Travis CI](https://travis-ci.org/TheAlgorithms/Python/pull_requests) to save time and mental energy. After you have submitted your pull request, you should see the Travis tests start to run at the bottom of your submission page. If those tests fail, then click on the ___details___ button try to read through the Travis output to understand the failure. If you do not understand, please leave a comment on your submission page and a community member will try to help.
#### Coding Style
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,
- Please write in Python 3.7+. __print()__ is a function in Python 3 so __print "Hello"__ will _not_ work but __print("Hello")__ will.
- Please focus hard on naming of functions, classes, and variables. Help your reader by using __descriptive names__ that can help you to remove redundant comments.
- Single letter variable names are _old school_ so please avoid them unless their life only spans a few lines.
- Expand acronyms because __gcd()__ is hard to understand but __greatest_common_divisor()__ is not.
- Please follow the [Python Naming Conventions](https://pep8.org/#prescriptive-naming-conventions) so variable_names and function_names should be lower_case, CONSTANTS in UPPERCASE, ClassNames should be CamelCase, etc.
- We encourage the use of Python [f-strings](https://realpython.com/python-f-strings/#f-strings-a-new-and-improved-way-to-format-strings-in-python) where the make the code easier to read.
- Please consider running [__psf/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request. This is not yet a requirement but it does make your code more readable and automatically aligns it with much of [PEP 8](https://www.python.org/dev/peps/pep-0008/). 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
black .
```
- 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.
```bash
pip3 install flake8 # only required the first time
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
```
- 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!
- Original code submission require docstrings or comments to describe your work.
- Always use 4 spaces to indent.
- More on docstrings and comments:
- Original code submission requires comments to describe your work.
- More on comments and docstrings:
If you are using a Wikipedia article or some other source material to create your algorithm, please add the URL in a docstring or comment to help your reader.
The following are considered to be bad and may be requested to be improved:
@ -52,34 +64,40 @@ We want your work to be readable by others; therefore, we encourage you to note
This is too trivial. Comments are expected to be explanatory. For comments, you can write them above, on or below a line of code, as long as you are consistent within the same piece of code.
*Sometimes, docstrings are avoided.* This will happen if you are using some editors and not careful with indentation:
```python
"""
This function sums a and b
"""
def sum(a, b):
return a + b
```
However, if you insist to use docstrings, we encourage you to put docstrings inside functions. Also, please pay attention to indentation to docstrings. The following is acceptable in this case:
We encourage you to put docstrings inside your functions but please pay attention to indentation of docstrings. The following is acceptable in this case:
```python
def sumab(a, b):
"""
This function sums two integers a and b
This function returns the sum of two integers a and b
Return: a + b
"""
return a + b
```
- `lambda`, `map`, `filter`, `reduce` and complicated list comprehension are welcome and acceptable to demonstrate the power of Python, as long as they are simple enough to read.
- Write tests (especially [__doctests__](https://docs.python.org/3/library/doctest.html)) to illustrate and verify your work. We highly encourage the use of _doctests on all functions_.
- This is arguable: **write comments** and assign appropriate variable names, so that the code is easy to read!
```python
def sumab(a, b):
"""
This function returns the sum of two integers a and b
Return: a + b
>>> sum(2, 2)
4
>>> sum(-2, 3)
1
>>> sum(4.9, 6.1)
10.0
"""
return a + b
```
- Write tests to illustrate your work.
These doctests will be run by pytest as part of our automated testing so please try to run your doctests locally and make sure that they are found and pass:
```bash
python3 -m doctest -v my_submission.py
```
The following "testing" approaches are **not** encouraged:
The use of the Python builtin __input()__ function is **not** encouraged:
```python
input('Enter your input:')
@ -87,34 +105,31 @@ We want your work to be readable by others; therefore, we encourage you to note
input = eval(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:
However, if your code uses __input()__ then we encourage you to gracefully deal with leading and trailing whitespace in user input by adding __.strip()__ as in:
```python
starting_value = int(input("Please enter a starting value: ").strip())
```
Please write down your test case, like the following:
```python
def sumab(a, b):
return a + b
# Write tests this way:
print(sumab(1, 2)) # 1+2 = 3
print(sumab(6, 4)) # 6+4 = 10
# Or this way:
print("1 + 2 = ", sumab(1, 2)) # 1+2 = 3
print("6 + 4 = ", sumab(6, 4)) # 6+4 = 10
The use of [Python type hints](https://docs.python.org/3/library/typing.html) is encouraged for function parameters and return values. Our automated testing will run [mypy](http://mypy-lang.org) so run that locally before making your submission.
```python
def sumab(a: int, b: int) --> int:
pass
```
Better yet, if you know how to write [__doctests__](https://docs.python.org/3/library/doctest.html), please consider adding them.
- [__list comprehensions and generators__](https://docs.python.org/3/tutorial/datastructures.html#list-comprehensions) are preferred over the use of `lambda`, `map`, `filter`, `reduce` but the important thing is to demonstrate the power of Python in code that is easy to read and maintain.
- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
- If you need a third party module that is not in the file __requirements.txt__, please add it to that file as part of your submission.
#### Other Standard While Submitting Your Work
- File extension for code should be `.py`. Jupiter notebook files are acceptable in machine learning algorithms.
- Strictly use snake case (underscore separated) in your file name, as it will be easy to parse in future using scripts.
- Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structue.
- 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.
@ -135,5 +150,4 @@ We want your work to be readable by others; therefore, we encourage you to note
- Happy coding!
Writer [@poyea](https://github.com/poyea), Jun 2019.