Upstream pre commit config #15
Conversation
|
Thanks! Will take a look soon. |
README.rst
Outdated
| 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.
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
left a comment
There was a problem hiding this comment.
Need to mention running pre-commit install --hook-type commit-msg for new users.
I've restored the original instructions, and filed pre-commit/pre-commit#1895 to have |
milind-shakya-sp
left a comment
There was a problem hiding this comment.
Thanks for the changes! Looks great
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.