Add pre-commit hooks installation to Contribute page #5403
Merged
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
adriangb
approved these changes
Apr 6, 2023
| @@ -49,21 +49,25 @@ source env/bin/activate | |||
| # 3. Install pydantic, dependencies, test dependencies and doc dependencies | |||
| make install | |||
|
|
|||
| # 4. Checkout a new branch and make your changes | |||
| # 4. Install pre-commit hooks | |||
| pip install pre-commit | |||
There was a problem hiding this comment.
Like I said I think pipx is good for this sort of thing. Maybe add that as a suggestion?
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.
Adds a step to install pre-commit hooks to setup instructions for contributors.
Change Summary
Related issue number
Checklist
changes/<pull request or issue id>-<github username>.mdfile added describing change(see changes/README.md for details)