Add auto-formatters as pre-commit hooks #147
Closed
Conversation
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
facebook-github-bot
added
the
CLA Signed
Contributor
Author
|
Locally all tests also pass after applying the auto-formatting, so this PR should be good to go as soon as the configs are approved. |
ejguan
approved these changes
Jan 3, 2022
Contributor
ejguan
left a comment
ejguan
left a comment
There was a problem hiding this comment.
This is amazing. Thank you so much. And, sorry for the late response, I was out of office,
Contributor
|
LMK after you push all the needed changes, then I will import and land. Thanks a lot. |
pmeier
changed the title
Contributor
|
@ejguan has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
ejguan
approved these changes
Jan 4, 2022
Contributor
ejguan
left a comment
ejguan
left a comment
There was a problem hiding this comment.
Thank you so much. Have a super nit: Can you add several words in CONTRIBUTING.md as the PR summary to help others understand how it works?
Contributor
Author
Contributor
|
@ejguan has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 adds a couple of
pre-commithooks for auto-formatting files in the repository. The include mainlyblackandusortthat are run throughufmtand are fully compatible with Meta internal workflows. In addition,flake8can also be run through this framework.To install the hooks
pip install pre-commit firstand afterwards runpre-commit installinside the repository. Now, every time yougit commitsomething, these hooks will run and make sure the code format is correct. You can also invoke them manually withpre-commit run, which will check all staged files.For now I only included the configuration files. If they are approved, I'll pull the trigger and push all changes that need to be made to the repository to be compatible with the format.