[Add] Introduce Pre-Commit Hooks and Configuration Files #22
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
ZwwWayne
reviewed
Jun 3, 2023
setup.cfg
Outdated
| known_first_party = mmgpt | ||
| known_third_party = PIL,cv2,mmcv,numpy,pytest,mmengine,torch | ||
| no_lines_before = STDLIB,LOCALFOLDER | ||
| default_section = THIRDPARTY |
There was a problem hiding this comment.
seems this file should have an empty line in the end?
There was a problem hiding this comment.
Thanks for pointing that out. I've added an empty line at the end of the file as suggested. Please let me know if there are any other changes needed.
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.
Description
This commit introduces a pre-commit configuration file and a setup configuration file to improve the code quality and maintainability of the project.
Changes:
.pre-commit-config.yamlfile has been added, which includes several hooks to maintain code quality and consistency. These hooks include:flake8for Python style guide enforcementisortfor sorting importsyapffor auto-formatting Python codetrailing-whitespace,check-yaml,end-of-file-fixer,requirements-txt-fixer,double-quote-string-fixer,check-merge-conflict,fix-encoding-pragma,mixed-line-endingfor various code cleanup and sanity checksmdformatfor Markdown formattingcodespellfor spell checkingdocformatterfor Python docstring formattingpyupgradefor upgrading Python syntaxsetup.cfgfile has been added, which includes configuration settings foryapfandisort.These changes should help in maintaining the quality of the codebase, enforcing coding standards, and making the review process smoother and more efficient.