Multimodal-GPT icon indicating copy to clipboard operation
Multimodal-GPT copied to clipboard

[Add] Introduce Pre-Commit Hooks and Configuration Files

Open yhna940 opened this issue 2 years ago • 0 comments

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:

  1. A new .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 enforcement
    • isort for sorting imports
    • yapf for auto-formatting Python code
    • trailing-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 checks
    • mdformat for Markdown formatting
    • codespell for spell checking
    • docformatter for Python docstring formatting
    • pyupgrade for upgrading Python syntax
  2. A new setup.cfg file has been added, which includes configuration settings for yapf and isort.

These changes should help in maintaining the quality of the codebase, enforcing coding standards, and making the review process smoother and more efficient.

yhna940 avatar May 12 '23 11:05 yhna940