Skip to content
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.

Sign up for GitHub

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

Minor touch-ups to GitHub PULL_REQUEST_TEMPLATE #17207

Merged
merged 5 commits into from
Aug 9, 2017
Merged

Minor touch-ups to GitHub PULL_REQUEST_TEMPLATE #17207

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
81ceb0e
Remove leading space from tasklist
dhimmel Aug 9, 2017
da84a07
Remove --patch default git diff option
dhimmel Aug 9, 2017
a496984
Remove unnecessary backticks
dhimmel Aug 9, 2017
a5a8f24
Use long arg to be more explicit
dhimmel Aug 9, 2017
75b3df6
Revert changes to git diff
dhimmel Aug 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- [ ] closes #xxxx
- [ ] tests added / passed
- [ ] passes ``git diff upstream/master -u -- "*.py" | flake8 --diff``
- [ ] whatsnew entry
- [ ] closes #xxxx
- [ ] tests added / passed
- [ ] passes `git diff upstream/master -- "*.py" | flake8 --diff`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would refrain from changing the git diff checks. Unless you can confirm that these work across all platforms (we've run into this problem before), that should not be touched.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the git diff documentation, which appears to be language agnostic, going back to git version 1.8.5. I didn't see anything that would cause issues (like --patch not being default).

However, I only tested the changes on Linux, not macOS or Windows. @gfyoung I'm happy to revert. I'm also happy to leave this open and seek verification from mac and windows users. Which do you prefer?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's revert for the time being because the existing commands work as desired.

- [ ] whatsnew entry
2 changes: 1 addition & 1 deletion doc/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ the `flake8 <http://pypi.python.org/pypi/flake8>`_ tool
and report any stylistic errors in your code. Therefore, it is helpful before
submitting code to run the check yourself on the diff::

git diff master -u -- "*.py" | flake8 --diff
git diff master --patch -- "*.py" | flake8 --diff
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above


This command will catch any stylistic errors in your changes specifically, but
be beware it may not catch all of them. For example, if you delete the only
Expand Down