-
-
Couldn't load subscription status.
- Fork 49k
Update developer toolset instructions in CONTRIBUTING.md #7762
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update developer toolset instructions in CONTRIBUTING.md #7762
Conversation
1a86be3 to
1e07427
Compare
| - 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, | ||
|
|
||
| ```bash | ||
| python3 -m pip install black # only required the first time | ||
| black . | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my opinion, this part isn't necessary because when you create the pr the pre-commit bot automatically formats it because it's in the pre-commit
|
I do not see the value of these changes.
|
Replace/remove instructions on individual tools usage with pre-commit.
Instruction with flake8 is a bit misleading since the project uses flake8 plugins that should be installed to get the same linting as done by CI on each PR.
Also, add a few line breaks. It doe not affect rendered page and fits into the screen in the editor.
Checklist:
Fixes: #{$ISSUE_NO}.