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

Add Ruff Linter Integration and Pre-Commit Hook #205

Closed
wants to merge 3 commits into from

Conversation

deepakdinesh1123
Copy link
Contributor

Overview

This PR implements the integration of the Ruff linter into our Python project and sets up a pre-commit hook to enforce code quality standards before commits are made.

@deepakdinesh1123 deepakdinesh1123 marked this pull request as draft April 22, 2024 04:43
@@ -0,0 +1,20 @@
exclude: ^docs/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I am not wrong, this prevents running pre-commit on any file inside docs dir?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, we can see if including docs in linters would be beneficial or not, this was done as an experiment we can check if mdx is also parsed by pre-comit.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, let me have a look.

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: check-added-large-files
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any specific reason for checking for large files? 🤔 I don't think thats required.
Also, adding requirements-txt-fixer and check-yaml might be helpful.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a template that was taken from another project that I worked on to check the feasibility of including it in this project, you can make any modifications that you see fit.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay 👍

@deepakdinesh1123 deepakdinesh1123 deleted the feat/linter branch August 6, 2024 07:30
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

Successfully merging this pull request may close these issues.

2 participants