Add pre-commit code formatting #10
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
Serneum
force-pushed
the
add-pre-commit-format
branch
from
bad8bdc
to
2c4618a
Compare
jhodapp
approved these changes
Apr 11, 2022
calebbourg
approved these changes
Apr 12, 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.
This change adds a new pre-commit hook that will run
cargo fmtand add the changed files to the commit. This ensures that all of the code in the repository meets our code quality standards, and removes the responsibility of running thefmtcommand from the author so that they are not forced to remember and reviewers do not need to ask for formatting updates. This also conveniently adds the updates to the commit containing the changed files so that the author does not need to do any squashing or fixing up later.To install the new commit hook in your local workspace, you can run
./scripts/create-git-hooks, which will set up a symlink to a hooks-wrapper script that can run any commit hook that we currently have or add in the future.