You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+38-31Lines changed: 38 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,25 +30,32 @@ Your contribution will be tested by our [automated testing on Travis CI](https:/
30
30
We want your work to be readable by others; therefore, we encourage you to note the following:
31
31
32
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
-
34
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.
35
-
- Single letter variable names are _old school_ so please avoid them unless their life only spans a few lines.
36
-
- Expand acronyms because __gcd()__ is hard to understand but __greatest_common_divisor()__ is not.
37
-
- 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.
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
+
38
39
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.
40
41
41
-
- 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,
42
-
```bash
43
-
pip3 install black # only required the first time
44
-
black .
45
-
```
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
+
```
46
50
47
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.
48
-
```bash
49
-
pip3 install flake8 # only required the first time
- Original code submission require docstrings or comments to describe your work.
54
61
@@ -93,9 +100,10 @@ We want your work to be readable by others; therefore, we encourage you to note
93
100
```
94
101
95
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:
96
-
```bash
97
-
python3 -m doctest -v my_submission.py
98
-
```
103
+
104
+
```bash
105
+
python3 -m doctest -v my_submission.py
106
+
```
99
107
100
108
The use of the Python builtin __input()__ function is **not** encouraged:
101
109
@@ -110,44 +118,43 @@ We want your work to be readable by others; therefore, we encourage you to note
110
118
```python
111
119
starting_value =int(input("Please enter a starting value: ").strip())
112
120
```
113
-
121
+
114
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.
115
-
```python
116
-
def sumab(a: int, b: int) --> int:
123
+
124
+
```python
125
+
defsumab(a: int, b: int) --> int:
117
126
pass
118
127
```
119
128
120
-
- [__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.
121
129
122
-
- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
123
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.
124
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.
125
137
126
138
#### Other Standard While Submitting Your Work
127
139
128
140
- File extension for code should be `.py`. Jupiter notebook files are acceptable in machine learning algorithms.
129
-
130
-
- Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structue.
131
-
132
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.
133
144
134
-
If possible, follow the standard *within* the folder you are submitting to.
135
145
136
-
- If you have modified/added code work, make sure the code compiles before submitting.
137
146
147
+
- If you have modified/added code work, make sure the code compiles before submitting.
138
148
- If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
139
-
140
149
- Do not update the README.md or DIRECTORY.md file which will be periodically autogenerated by our Travis CI processes.
141
-
142
150
- Add a corresponding explanation to [Algorithms-Explanation](https://github.com/TheAlgorithms/Algorithms-Explanation) (Optional but recommended).
143
-
144
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.
145
152
146
-
- Most importantly,
147
153
154
+
155
+
- Most importantly,
148
156
-**Be consistent in the use of these guidelines when submitting.**
0 commit comments