Improve pre-commit hook and docs #1774
Open
Conversation
This file contains 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
* Add the `description` field that will appear on https://pre-commit.com/hooks.html (I’m about to submit it). * Describe what pre-commit does a little more. * Describe the `pre-commit autoupdate` step required to pin to a specific version rather than `master`. Using `master` could be broken, and isn't reproducible between environments. Indeed pre-commit warns if you use `master`: ``` [WARNING] The 'rev' field of repo 'https://github.com/standard/standard' appears to be a mutable reference (moving tag / branch). Mutable references are never updated after first install and are not supported. See https://pre-commit.com/#using-the-latest-version-for-a-repository for more details. Hint: `pre-commit autoupdate` often fixes this. ```
|
🙌 Thanks for opening this pull request! You're awesome. |
LinusU
approved these changes
May 29, 2022
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.
What is the purpose of this pull request? (put an "X" next to item)
[x] Documentation update
What changes did you make? (Give an overview)
Add the
descriptionfield that will appear on https://pre-commit.com/hooks.html (I’m about to submit it).Describe what pre-commit does a little more.
Describe the
pre-commit autoupdatestep required to pin to a specific version rather thanmaster. Usingmastercould be broken, and isn't reproducible between environments. Indeed pre-commit warns if you usemaster:Which issue (if any) does this pull request address?
No issue.
Is there anything you'd like reviewers to focus on?
Nope.