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
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,14 @@ Use [pre-commit](https://pre-commit.com/#installation) to automatically format y
56
56
python3 -m pip install pre-commit # only required the first time
57
57
pre-commit install
58
58
```
59
-
That's it! The plugin will run every time you commit any changes. If there are any errors found during the run, fix them and commit those changes. You can even run the plugin manually on all files:
59
+
That's it! The plugin will run every time you commit any changes. If there are any errors found during the run, fix them and commit those changes.
60
+
Pre-commit includes
61
+
[black](https://github.com/psf/black),
62
+
[isort](https://github.com/PyCQA/isort),
63
+
[mypy](http://mypy-lang.org) and
64
+
[flake8](https://flake8.pycqa.org/en/latest/).
65
+
66
+
You can even run the plugin manually on all files:
60
67
61
68
```bash
62
69
pre-commit run --all-files --show-diff-on-failure
@@ -74,13 +81,6 @@ We want your work to be readable by others; therefore, we encourage you to note
74
81
75
82
- 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.
76
83
77
-
- Do not forget that running `pre-commit` checks locally will help you to follow code quality standards.
78
-
It will run a set of tools including
79
-
[black](https://github.com/psf/black),
80
-
[isort](https://github.com/PyCQA/isort),
81
-
[mypy](http://mypy-lang.org) and
82
-
[flake8](https://flake8.pycqa.org/en/latest/).
83
-
84
84
- Original code submission require docstrings or comments to describe your work.
85
85
86
86
- More on docstrings and comments:
@@ -141,7 +141,7 @@ We want your work to be readable by others; therefore, we encourage you to note
141
141
starting_value =int(input("Please enter a starting value: ").strip())
142
142
```
143
143
144
-
The use of [Python type hints](https://docs.python.org/3/library/typing.html) is encouraged for function parameters and return values.
144
+
The use of [Python type hints](https://docs.python.org/3/library/typing.html) is encouraged for function parameters and return values.
145
145
Our automated testing will run [mypy](http://mypy-lang.org) so run that locally with pre-commit before making your submission.
0 commit comments