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

Setup pre-commit #452

Open
tushar5526 opened this issue Nov 17, 2023 · 3 comments
Open

Setup pre-commit #452

tushar5526 opened this issue Nov 17, 2023 · 3 comments
Assignees

Comments

@tushar5526
Copy link
Member

Set up pre-commit to run black, flake8, pytest (if possible) before commits.

@adesh1998
Copy link

I would like to work on this issue but I do have one question. How to test the changes like how would i get to know that git commit is working fine

@AdityyaX
Copy link

AdityyaX commented Dec 4, 2023

Subject: Request to Assign Issue: Set Up Pre-commit for Black, Flake8, and pytest

Hi @tushar5526 sir,

I hope this message finds you well. I wanted to discuss the implementation of a pre-commit setup within our repository to streamline our coding standards and ensure consistency across commits.

Overview of Implementation:

  • Black: For code formatting and maintaining a consistent style.
  • Flake8: To perform linting checks and ensure adherence to coding standards.
  • pytest: If applicable, to run tests before each commit, ensuring that new changes do not break existing functionality.

This integration aligns with our goal of maintaining a high-quality codebase and minimizing manual efforts in code formatting and checks.

Expected Behavior:

  1. Black: Automatically formats the code according to its defined style guide, ensuring consistent formatting across the codebase.
  2. Flake8: Checks the codebase for linting issues and ensures compliance with coding standards specified in the configuration.
  3. pytest (if applicable): Executes tests before each commit, verifying that new changes do not break existing functionality. Any failing tests should prevent the commit.

I'm eager to work on this issue and would greatly appreciate it if you could assign this issue to me.

@tushar5526
Copy link
Member Author

Assigned, it would be helpful if you can add in isort as well. We can skip pytest for now on each commits.

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

No branches or pull requests

3 participants