[Add] Introduce Pre-Commit Hooks and Configuration Files #22
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.yaml
file has been added, which includes several hooks to maintain code quality and consistency. These hooks include:flake8
for Python style guide enforcementisort
for sorting importsyapf
for 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-ending
for various code cleanup and sanity checksmdformat
for Markdown formattingcodespell
for spell checkingdocformatter
for Python docstring formattingpyupgrade
for upgrading Python syntaxsetup.cfg
file has been added, which includes configuration settings foryapf
andisort
.These changes should help in maintaining the quality of the codebase, enforcing coding standards, and making the review process smoother and more efficient.