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
- Update Python version from 3.13+ to 3.14+ (matches pyproject.toml)
- Replace outdated black formatter recommendation with ruff format (matches .pre-commit-config.yaml)
- Update PEP 8 URL to canonical peps.python.org (old URL 302-redirects)
- Fix inconsistent mypy URL from http://www.mypy-lang.org to https://mypy-lang.org
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,19 +77,19 @@ pre-commit run --all-files --show-diff-on-failure
77
77
78
78
We want your work to be readable by others; therefore, we encourage you to note the following:
79
79
80
-
- 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.
80
+
- Please write in Python 3.14+. For instance: `print()` is a function in Python 3 so `print "Hello"` will *not* work but `print("Hello")` will.
81
81
- 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
82
- Single letter variable names are *old school* so please avoid them unless their life only spans a few lines.
83
83
- Expand acronyms because `gcd()` is hard to understand but `greatest_common_divisor()` is not.
84
84
- 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.
85
85
86
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.
87
87
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 [__ruff format__](https://docs.astral.sh/ruff/formatter/) 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://peps.python.org/pep-0008/). To use it,
89
89
90
90
```bash
91
-
python3 -m pip install black# only required the first time
92
-
black.
91
+
python3 -m pip install ruff# only required the first time
92
+
ruff format.
93
93
```
94
94
95
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.
@@ -183,7 +183,7 @@ We want your work to be readable by others; therefore, we encourage you to note
183
183
- If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
184
184
- Do not update the README.md or DIRECTORY.md file which will be periodically autogenerated by our GitHub Actions processes.
185
185
- Add a corresponding explanation to [Algorithms-Explanation](https://github.com/TheAlgorithms/Algorithms-Explanation) (Optional but recommended).
186
-
- 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.
186
+
- All submissions will be tested with [__mypy__](https://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.
187
187
188
188
- Most importantly,
189
189
-__Be consistent in the use of these guidelines when submitting.__
0 commit comments