Conversation
|
Okay, so from what I gather, this pre-commit thing is actually a Python framework that people have to install just to be able to reference hooks from a repository, right? If so, could you please briefly document the setup that people need to go through to actually use this? A feature like this is a bit niche, I think, and even more so if people need to already know about the specific tool and have it installed beforehand. I would also personally start by giving them an example of how to use an actual standard Git hook, which takes minutes to set up, and then mention that there is this convenience feature on top of that for those who want it (but it's not strictly necessary, it's a small extra convenience). |
|
Thanks for taking a look at this @NathanLovato!
This is a great point and I have refactored in favor of a simple POSIX standard Git hook!
I added an example of how to use the standard Git hook to the README and instructions for copying the hook to the correct directory I wasn't sure about the best place to explain the hook in the README, so let me know if you think it has a better home further down the file, etc. |
Please check if the PR fulfills these requirements:
Related issue (if applicable): #141
What kind of change does this PR introduce?
Does this PR introduce a breaking change?
New feature or change
What is the current behavior?
There is no standard Git pre-commit hook, so users who want to use gdscript-formatter as a pre-commit hook have to configure it manually.
What is the new behavior?
Users can copy this pre-commit hook into their
.git/hooks/pre-commitdirectory to automatically format.gdfiles prior to each Git commit.Other information
Fixes #141