DOC Update contributing guide for flake8-diff #16758
Merged
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
NicolasHug
reviewed
Mar 24, 2020
doc/developers/contributing.rst
Outdated
|
|
||
| $ git remote add upstream https://github.com/scikit-learn/scikit-learn.git | ||
|
|
||
| `flake8 path_to_file` would work but would look for any PEP8 violation in |
There was a problem hiding this comment.
I'd remove, let's not give them bad ideas
doc/developers/contributing.rst
Outdated
Comment on lines
364
to
367
| which requires you to have set up the remote `upstream` branch to the main | ||
| scikit-learn repository:: | ||
|
|
||
| $ git remote add upstream https://github.com/scikit-learn/scikit-learn.git |
There was a problem hiding this comment.
I'd remove. The remote should be properly added already, it's in the guidelines above. IMO it's fair to assume contributors have followed them, and we need to keep the section reasonably short
There was a problem hiding this comment.
or we could point them to the section which they should have followed. In my experience people don't follow those steps.
Co-Authored-By: Nicolas Hug <[email protected]>
Co-Authored-By: Nicolas Hug <[email protected]>
rth
reviewed
Mar 24, 2020
doc/developers/contributing.rst
Outdated
|
|
||
| git diff upstream/master -u -- "*.py" | flake8 --diff | ||
|
|
||
| or `make flake8-diff` which should work on unix-like system. |
There was a problem hiding this comment.
If we mention it, let's also change the Makefile to use the above command for flake8-diff
adrinjalali
approved these changes
Mar 24, 2020
Co-Authored-By: Nicolas Hug <[email protected]>
|
Thanks for the feedback everyone! |
gio8tisu
pushed a commit
to gio8tisu/scikit-learn
that referenced
this pull request
May 15, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Reference Issues/PRs
Fixes #16755
What does this implement/fix? Explain your changes.
This small PR updates the description of item 5: Make sure that your PR does not add PEP8 violations. The
make flake8-diffcommand is replaced with:git diff upstream/master -u -- "*.py" | flake8 --diffThis command works on all supported platforms. A reminder on how to add the remote
upstreammaster is provided.Any other comments?
Sorry for the removed whitespaces, my IDE automatically removes trailing whitespaces when saving a file. I know it's not the best (this section precisely states not to change stuff that is not related to the PR 😆), and will revert them if you really want to.