Skip to content

Commit 3d16a0a

Browse files
Improve punctuation and readability in CONTRIBUTING.md
This PR fixes minor punctuation and readability issues in CONTRIBUTING.md to make the text clearer and easier to follow. - Added commas for better sentence flow (e.g., after introductory clauses and before conjunctions) - Corrected hyphenation for compound words (e.g., "single-letter variable names") - Improved spacing around periods and inline code - Fixed minor grammar inconsistencies without changing meaning These changes are purely editorial and do not affect any code or instructions.
1 parent a71618f commit 3d16a0a

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,27 +79,27 @@ We want your work to be readable by others; therefore, we encourage you to note
7979

8080
- Please write in Python 3.13+. For instance: `print()` is a function in Python 3 so `print "Hello"` will *not* work but `print("Hello")` will.
8181
- 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.
82-
- Single letter variable names are *old school* so please avoid them unless their life only spans a few lines.
82+
- Single-letter variable names are *old school*, so please avoid them unless their life only spans a few lines.
8383
- Expand acronyms because `gcd()` is hard to understand but `greatest_common_divisor()` is not.
8484
- 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.
8585

86-
- 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 they make the code easier to read.
86+
- 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 they make the code easier to read.
8787

88-
- 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__ formatter is now hosted by the Python Software Foundation. To use it,
88+
- 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__ formatter is now hosted by the Python Software Foundation. To use it,
8989

9090
```bash
9191
python3 -m pip install black # only required the first time
9292
black .
9393
```
9494

95-
- All submissions will need to pass the test `ruff .` before they will be accepted so if possible, try this test locally on your Python file(s) before submitting your pull request.
95+
- All submissions will need to pass the test `ruff .` before they will be accepted, so if possible, try this test locally on your Python file(s) before submitting your pull request.
9696

9797
```bash
9898
python3 -m pip install ruff # only required the first time
9999
ruff check
100100
```
101101

102-
- Original code submission require docstrings or comments to describe your work.
102+
- Original code submission requires docstrings or comments to describe your work.
103103

104104
- More on docstrings and comments:
105105

@@ -113,7 +113,7 @@ We want your work to be readable by others; therefore, we encourage you to note
113113

114114
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.
115115

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

118118
```python
119119
def sum_ab(a, b):
@@ -139,7 +139,7 @@ We want your work to be readable by others; therefore, we encourage you to note
139139
return a + b
140140
```
141141

142-
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:
142+
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:
143143

144144
```bash
145145
python3 -m doctest -v my_submission.py
@@ -176,12 +176,12 @@ We want your work to be readable by others; therefore, we encourage you to note
176176
#### Other Requirements for Submissions
177177
- 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.
178178
- The file extension for code files should be `.py`. Jupyter Notebooks should be submitted to [TheAlgorithms/Jupyter](https://github.com/TheAlgorithms/Jupyter).
179-
- Strictly use snake_case (underscore_separated) in your file_name, as it will be easy to parse in future using scripts.
179+
- Strictly use snake_case (underscore_separated) in your file_name, as it will be easy to parse in the future using scripts.
180180
- Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structure.
181181
- If possible, follow the standard *within* the folder you are submitting to.
182182
- If you have modified/added code work, make sure the code compiles before submitting.
183183
- If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
184-
- Do not update the README.md or DIRECTORY.md file which will be periodically autogenerated by our GitHub Actions processes.
184+
- Do not update the README.md or DIRECTORY.md file, which will be periodically autogenerated by our GitHub Actions processes.
185185
- Add a corresponding explanation to [Algorithms-Explanation](https://github.com/TheAlgorithms/Algorithms-Explanation) (Optional but recommended).
186186
- 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.
187187

0 commit comments

Comments
 (0)