Upstream pre commit config #15
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
|
Thanks! Will take a look soon. |
milin
reviewed
Apr 28, 2021
README.rst
Outdated
| @@ -62,8 +62,7 @@ You need to have precommit setup to use this hook. | |||
| :: | |||
|
|
|||
| pip install pre-commit | |||
| pre-commit install | |||
| pre-commit install --hook-type commit-msg | |||
| pre-commit install --install-hooks | |||
There was a problem hiding this comment.
This won't work. Need to explicitly run pre-commit install --hook-type commit-msg otherwise giticket wont work. needs to be reverted
There was a problem hiding this comment.
Looks like you're right. I expected that --install-hooks was minimally sufficient, but it doesn't actually install any hooks, just sets up the envs for the existing hooks.
milin
reviewed
Apr 28, 2021
CONTRIBUTING.rst
Outdated
| 4. Set up pre-commit:: | ||
|
|
||
| $ pip install pre-commit | ||
| $ pre-commit install --install-hooks |
There was a problem hiding this comment.
Would add pre-commit install --hook-type commit-msg step here as well
milin
requested changes
Apr 28, 2021
I've restored the original instructions, and filed pre-commit/pre-commit#1895 to have |
milind-shakya-sp
approved these changes
Apr 30, 2021
milind-shakya-sp
approved these changes
Apr 30, 2021
milin
approved these changes
Apr 30, 2021
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.
This PR sets up pre-commit on the repo itself. It enables a few simple tests, and then turns on flake8 on commit.
Docs are also updated to simplify the installation, and to instruct developers on how to set up pre-commit themselves.