This pull request introduces a set of powerful pre-commit hooks to improve code quality and maintain consistency across our project. The following pre-commit hooks have been added:
check-added-large-files: This hook scans for large files that have been added, helping to identify potential performance bottlenecks early in the development process.
end-of-file-fixer: The hook ensures that all files end with an appropriate end-of-file marker, promoting a uniform and neat codebase.
trailing-whitespace: This hook eliminates trailing whitespaces in files, preventing unnecessary distractions and improving code readability.
no-commit-to-branch: With this hook, commits directly to the main and develop branches are disallowed, reinforcing our version control workflow and promoting feature branching.
commitizen: The hook enables commitizen support, encouraging standardized commit messages and facilitating changelog generation.
check-github-workflows: This hook validates the GitHub workflows, ensuring that they are correctly set up and ready for smooth CI/CD integration.
pyupgrade: The hook utilizes pyupgrade to perform Python 3.10+ compatible code refactoring, staying up-to-date with the latest language features.
ruff: With this hook, Ruff ensures codebase consistency by fixing any potential issues automatically.
black: The hook leverages black to automatically format code according to the Python style guide, fostering a consistent and elegant codebase.
In addition to the pre-commit hooks, this pull request also adds comprehensive contribution guidelines to the project. These guidelines empower both new and existing contributors with a clear understanding of our collaboration practices.
This pull request introduces a set of powerful pre-commit hooks to improve code quality and maintain consistency across our project. The following pre-commit hooks have been added:
check-added-large-files: This hook scans for large files that have been added, helping to identify potential performance bottlenecks early in the development process.end-of-file-fixer: The hook ensures that all files end with an appropriate end-of-file marker, promoting a uniform and neat codebase.trailing-whitespace: This hook eliminates trailing whitespaces in files, preventing unnecessary distractions and improving code readability.no-commit-to-branch: With this hook, commits directly to the main and develop branches are disallowed, reinforcing our version control workflow and promoting feature branching.commitizen: The hook enables commitizen support, encouraging standardized commit messages and facilitating changelog generation.check-github-workflows: This hook validates the GitHub workflows, ensuring that they are correctly set up and ready for smooth CI/CD integration.pyupgrade: The hook utilizespyupgradeto perform Python 3.10+ compatible code refactoring, staying up-to-date with the latest language features.ruff: With this hook, Ruff ensures codebase consistency by fixing any potential issues automatically.black: The hook leveragesblackto automatically format code according to the Python style guide, fostering a consistent and elegant codebase.In addition to the pre-commit hooks, this pull request also adds comprehensive contribution guidelines to the project. These guidelines empower both new and existing contributors with a clear understanding of our collaboration practices.