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

🔧 Update pre-commit Configuration File #16

Open
ARYAN-NIKNEZHAD opened this issue Sep 13, 2024 · 1 comment
Open

🔧 Update pre-commit Configuration File #16

ARYAN-NIKNEZHAD opened this issue Sep 13, 2024 · 1 comment

Comments

@ARYAN-NIKNEZHAD
Copy link

Description:

This package currently lacks a .pre-commit-config.yaml file, which is important for maintaining code quality and consistency. Without this configuration file, we miss out on several benefits provided by pre-commit hooks:

  1. Automated Code Checks: pre-commit allows us to run automated checks (e.g., linting, formatting) before commits, ensuring that code adheres to style guidelines and best practices.

  2. Error Prevention: By enforcing coding standards and preventing common mistakes, pre-commit helps reduce the likelihood of introducing errors or style inconsistencies.

  3. Consistency: Ensures that all contributors follow the same code quality checks, promoting uniformity across the codebase.

  4. Efficiency: Automates repetitive tasks, saving time and effort during code review and integration.

Action Items:

  • Create a .pre-commit-config.yaml file at the root of the project directory.
  • Configure the file with appropriate hooks for code formatting, linting, and other checks (e.g., black, flake8, isort).
  • Add instructions to the project's documentation for setting up pre-commit locally and installing the hooks.
@ARYAN-NIKNEZHAD
Copy link
Author

Hi @juanjcardona13
You can use my configuration
https://github.com/Lazarus-org/django_logging/blob/main/.pre-commit-config.yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant