Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔧 Missing .pre-commit-config for Local and CI Integration #3

Open
ARYAN-NIKNEZHAD opened this issue Jan 14, 2025 · 0 comments
Open
Assignees
Labels
configuration package config enhancement New feature or request

Comments

@ARYAN-NIKNEZHAD
Copy link
Contributor

Description:

The package is missing a .pre-commit-config.yaml file to enforce consistent code formatting, linting, and other quality checks across both local development and CI environments. Without this configuration, developers may introduce style inconsistencies or code that doesn’t pass basic quality checks, leading to issues during CI pipelines or code reviews.

Problems Identified:

  1. Inconsistent Code Style:

    • Without a pre-commit configuration, there is no automatic enforcement of code styles (e.g., using black, isort, etc.).
    • This leads to style inconsistencies across the codebase, increasing the difficulty of code reviews and collaboration.
  2. Lack of Pre-commit Hooks:

    • Important checks such as linting (via flake8), security scanning, and fixing common issues (via prettier, etc.) are not enforced before each commit, allowing errors and potential vulnerabilities to slip through.
  3. No Integration with CI:

    • The absence of pre-commit hooks in the CI pipeline allows non-compliant code to be merged, leading to build failures or technical debt over time.
  4. Manual Process:

    • Developers have to manually run linters and formatters, which can lead to human errors or oversight.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
configuration package config enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants