Skip to content

Commit 359e0e7

Browse files
Fixed grammatical errors in CONTRIBUTING.md (#5635)
1 parent 678535b commit 359e0e7

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ pre-commit run --all-files --show-diff-on-failure
6767
We want your work to be readable by others; therefore, we encourage you to note the following:
6868

6969
- Please write in Python 3.9+. For instance: `print()` is a function in Python 3 so `print "Hello"` will *not* work but `print("Hello")` will.
70-
- 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.
70+
- Please focus hard on the naming of functions, classes, and variables. Help your reader by using __descriptive names__ that can help you to remove redundant comments.
7171
- Single letter variable names are *old school* so please avoid them unless their life only spans a few lines.
7272
- Expand acronyms because `gcd()` is hard to understand but `greatest_common_divisor()` is not.
7373
- 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.
@@ -102,7 +102,7 @@ We want your work to be readable by others; therefore, we encourage you to note
102102

103103
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.
104104

105-
We encourage you to put docstrings inside your functions but please pay attention to indentation of docstrings. The following is a good example:
105+
We encourage you to put docstrings inside your functions but please pay attention to the indentation of docstrings. The following is a good example:
106106

107107
```python
108108
def sum_ab(a, b):
@@ -160,7 +160,7 @@ We want your work to be readable by others; therefore, we encourage you to note
160160
- [__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.
161161

162162
- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
163-
- 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.
163+
- 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.
164164

165165
#### Other Requirements for Submissions
166166
- If you are submitting code in the `project_euler/` directory, please also read [the dedicated Guideline](https://github.com/TheAlgorithms/Python/blob/master/project_euler/README.md) before contributing to our Project Euler library.
@@ -172,7 +172,7 @@ We want your work to be readable by others; therefore, we encourage you to note
172172
- If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
173173
- Do not update the README.md or DIRECTORY.md file which will be periodically autogenerated by our Travis CI processes.
174174
- Add a corresponding explanation to [Algorithms-Explanation](https://github.com/TheAlgorithms/Algorithms-Explanation) (Optional but recommended).
175-
- 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.
175+
- All submissions will be tested with [__mypy__](http://www.mypy-lang.org) so we encourage you to add [__Python type hints__](https://docs.python.org/3/library/typing.html) where it makes sense to do so.
176176

177177
- Most importantly,
178178
- __Be consistent in the use of these guidelines when submitting.__

0 commit comments

Comments
 (0)