Open
Conversation
Contributor
|
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). |
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
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.
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
.pre-commit-hooks.yaml, 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 reference this repo directly in their .pre-commit-config.yaml:
Other information
Fixes #141