-
-
Notifications
You must be signed in to change notification settings - Fork 46.6k
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
Closed
Cjkjvfnby
wants to merge
5
commits into
TheAlgorithms:master
from
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Closed
Update developer toolset instructions in CONTRIBUTING.md #7762
Cjkjvfnby
wants to merge
5
commits into
TheAlgorithms:master
from
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
14 tasks
cclauss
requested changes
Oct 29, 2022
1a86be3
to
1e07427
Compare
cclauss
reviewed
Mar 13, 2023
cclauss
reviewed
Mar 13, 2023
CaedenPH
requested changes
Mar 17, 2023
CONTRIBUTING.md
Outdated
Comment on lines
84
to
90
- 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.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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}
.