|
| 1 | +# Contributing guidelines |
| 2 | + |
| 3 | +## Before contributing |
| 4 | + |
| 5 | +Welcome to [TheAlgorithms/Python](https://github.com/TheAlgorithms/Python)! Before sending your pull requests, make sure that you **read the whole guidelines**. If you have any doubt on the contributing guide, please feel free to [state it clearly in an issue](https://github.com/TheAlgorithms/Python/issues/new) or ask the community in [Gitter](https://gitter.im/TheAlgorithms). |
| 6 | + |
| 7 | +## Contributing |
| 8 | + |
| 9 | +### Contributor |
| 10 | + |
| 11 | +We are very happy that you consider implementing algorithms and data structure for others! This repository is referenced and used by learners from all over the globe. Being one of our contributors, you agree and confirm that: |
| 12 | + |
| 13 | +- You did your work - no plagiarism allowed |
| 14 | + - Any plagiarized work will not be merged. |
| 15 | +- Your work will be distributed under [MIT License](License) once your pull request is merged |
| 16 | +- You submitted work fulfils or mostly fulfils our styles and standards |
| 17 | + |
| 18 | +**New implementation** is welcome! For example, new solutions for a problem, different representations for a graph data structure or algorithm designs with different complexity. |
| 19 | + |
| 20 | +**Improving comments** and **writing proper tests** are also highly welcome. |
| 21 | + |
| 22 | +### Contribution |
| 23 | + |
| 24 | +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. |
| 25 | + |
| 26 | +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. |
| 27 | + |
| 28 | +#### Coding Style |
| 29 | + |
| 30 | +We want your work to be readable by others; therefore, we encourage you to note the following: |
| 31 | + |
| 32 | +- Please write in Python 3.7+. __print()__ is a function in Python 3 so __print "Hello"__ will _not_ work but __print("Hello")__ will. |
| 33 | +- 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. |
| 34 | + - Single letter variable names are _old school_ so please avoid them unless their life only spans a few lines. |
| 35 | + - Expand acronyms because __gcd()__ is hard to understand but __greatest_common_divisor()__ is not. |
| 36 | + - 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. |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | +- 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. |
| 41 | + |
| 42 | + |
| 43 | + |
| 44 | +- 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, |
| 45 | + |
| 46 | + ```bash |
| 47 | + pip3 install black # only required the first time |
| 48 | + black . |
| 49 | + ``` |
| 50 | + |
| 51 | +- 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. |
| 52 | + |
| 53 | + ```bash |
| 54 | + pip3 install flake8 # only required the first time |
| 55 | + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics |
| 56 | + ``` |
| 57 | + |
| 58 | + |
| 59 | + |
| 60 | +- Original code submission require docstrings or comments to describe your work. |
| 61 | + |
| 62 | +- More on docstrings and comments: |
| 63 | + |
| 64 | + 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. |
| 65 | + |
| 66 | + The following are considered to be bad and may be requested to be improved: |
| 67 | + |
| 68 | + ```python |
| 69 | + x = x + 2 # increased by 2 |
| 70 | + ``` |
| 71 | + |
| 72 | + 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. |
| 73 | + |
| 74 | + We encourage you to put docstrings inside your functions but please pay attention to indentation of docstrings. The following is acceptable in this case: |
| 75 | + |
| 76 | + ```python |
| 77 | + def sumab(a, b): |
| 78 | + """ |
| 79 | + This function returns the sum of two integers a and b |
| 80 | + Return: a + b |
| 81 | + """ |
| 82 | + return a + b |
| 83 | + ``` |
| 84 | + |
| 85 | +- 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_. |
| 86 | + |
| 87 | + ```python |
| 88 | + def sumab(a, b): |
| 89 | + """ |
| 90 | + This function returns the sum of two integers a and b |
| 91 | + Return: a + b |
| 92 | + >>> sumab(2, 2) |
| 93 | + 4 |
| 94 | + >>> sumab(-2, 3) |
| 95 | + 1 |
| 96 | + >>> sumab(4.9, 5.1) |
| 97 | + 10.0 |
| 98 | + """ |
| 99 | + return a + b |
| 100 | + ``` |
| 101 | + |
| 102 | + 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: |
| 103 | + |
| 104 | + ```bash |
| 105 | + python3 -m doctest -v my_submission.py |
| 106 | + ``` |
| 107 | + |
| 108 | + The use of the Python builtin __input()__ function is **not** encouraged: |
| 109 | + |
| 110 | + ```python |
| 111 | + input('Enter your input:') |
| 112 | + # Or even worse... |
| 113 | + input = eval(input("Enter your input: ")) |
| 114 | + ``` |
| 115 | + |
| 116 | + 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: |
| 117 | + |
| 118 | + ```python |
| 119 | + starting_value = int(input("Please enter a starting value: ").strip()) |
| 120 | + ``` |
| 121 | + |
| 122 | + 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. |
| 123 | + |
| 124 | + ```python |
| 125 | + def sumab(a: int, b: int) --> int: |
| 126 | + pass |
| 127 | + ``` |
| 128 | + |
| 129 | + |
| 130 | + |
| 131 | +- [__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. |
| 132 | + |
| 133 | + |
| 134 | + |
| 135 | +- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms. |
| 136 | +- 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. |
| 137 | + |
| 138 | +#### Other Standard While Submitting Your Work |
| 139 | + |
| 140 | +- File extension for code should be `.py`. Jupiter notebook files are acceptable in machine learning algorithms. |
| 141 | +- Strictly use snake_case (underscore_separated) in your file_name, as it will be easy to parse in future using scripts. |
| 142 | +- Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structure. |
| 143 | +- If possible, follow the standard *within* the folder you are submitting to. |
| 144 | + |
| 145 | + |
| 146 | + |
| 147 | +- If you have modified/added code work, make sure the code compiles before submitting. |
| 148 | +- If you have modified/added documentation work, ensure your language is concise and contains no grammar errors. |
| 149 | +- Do not update the README.md or DIRECTORY.md file which will be periodically autogenerated by our Travis CI processes. |
| 150 | +- Add a corresponding explanation to [Algorithms-Explanation](https://github.com/TheAlgorithms/Algorithms-Explanation) (Optional but recommended). |
| 151 | +- 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. |
| 152 | + |
| 153 | + |
| 154 | + |
| 155 | +- Most importantly, |
| 156 | + - **Be consistent in the use of these guidelines when submitting.** |
| 157 | + - **Join** [Gitter](https://gitter.im/TheAlgorithms) **now!** |
| 158 | + - Happy coding! |
| 159 | + |
| 160 | +Writer [@poyea](https://github.com/poyea), Jun 2019. |
0 commit comments