Add pre-commit hooks to automatically format code on git commit #18
Conversation
README.md
Outdated
| @@ -105,6 +105,9 @@ pip install poetry | |||
| # Install dependencies | |||
| poetry install | |||
|
|
|||
| # Setup pre-commit hooks | |||
| pre-commit install | |||
There was a problem hiding this comment.
Would this be better as:
poetry run pre-commit install
Or should we poetry shell before or something else?
There was a problem hiding this comment.
Good catch! Ill take care of that in my next commit.
There was a problem hiding this comment.
To double check, on the other PR?
Also, I've really appreciated this PR (and think I'll like #19 too) - I'm not a software engineer, but am always keen to learn more! These have been tremendously educational for me, so thank you 🙌
There was a problem hiding this comment.
Updated the instruction here: 3d41505
There might be a merge conflict in the other PR's README.md after this one goes in. If so it'll be a simple fix :)
I'm not a software engineer, but am always keen to learn more! These have been tremendously educational for me, so thank you 🙌
Awww, brooo 😊 You are absolutely a software engineer!
I'm glad you find my code helpful! I'm happy to contribute and spread some knowledge.
This PR adds pre-commit, a Python library for configuring and running git hooks.
I added configuration to run the
blackcode formatter automatically whenever a user runsgit commit. It will only run on Git staged files. The pre-commit config also has checks for yaml files, adding a newline to the end of files, and removing trailing whitespaces from lines. I also ran these hooks on the entire code base, which applied minor formatting changes.