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

Adding a .pre-commit-config.yaml file for maintaining consistent style and code quality. #1913

Closed
Sai-Suraj-27 opened this issue Dec 16, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@Sai-Suraj-27
Copy link

Sai-Suraj-27 commented Dec 16, 2023

Is your feature request related to a problem? Please describe.
Not, a problem but this can be a great enhancement to the codebase.

Describe the solution you'd like
I'm thinking about adding a pre-commit configuration file (.pre-commit-config.yaml ) to the codebase as it helps improve the code quality and maintain consistency within the project. It will allow all the developers/future contributors to maintain a consistent code style. Adding this will help us by running some automated checks before anyone tries to make a commit.
Many (Almost all) good Python based organizations/repos maintain a pre-commit configuration file for these benefits.

Describe alternatives you've considered

Additional context
I have a good experience in adding this file to large codebases (ivy-llc/ivy#22220, ivy-llc/ivy#22974, gprMax/gprMax#354, )
So, if you think it is useful let me know I will make a PR, Thank you.

@Sai-Suraj-27 Sai-Suraj-27 added the enhancement New feature or request label Dec 16, 2023
@bfineran
Copy link
Contributor

Hi @Sai-Suraj-27 take a look at our Makefile - we standardize to use make style for linting and then have on PR actions that run make quality to check.

We haven't actively looked at adding a pre commit config, but maybe make style could fit in

@jeanniefinks
Copy link
Member

Hi @Sai-Suraj-27
Happy New Year; let us know your thoughts on the last comment from @bfineran, thanks!

Jeannie / Neural Magic

@jeanniefinks
Copy link
Member

Hello @Sai-Suraj-27
As it's been some time without a response, I am going to ahead and close this issue. If you want to continue the conversation, feel free to re-open thread.
Regards,
Jeannie / Neural Magic

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

No branches or pull requests

3 participants