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 pre-commit and Pylint #301

Open
wants to merge 19 commits into
base: develop
Choose a base branch
from
Open

Conversation

mayankpatibandla
Copy link
Member

@mayankpatibandla mayankpatibandla commented Oct 25, 2023

Summary:

Adds pre-commit to run some hooks that must pass before a commit is allowed. Some basic errors regarding whitespace and unused variables have been fixed. Also adds Pylint to GitHub actions.

Motivation:

The goal is to enforce a more consistent coding style and fix linting issues. Currently most errors have been disabled, but we will need to enable some of them later to comply to a chosen standard.

References (optional):

#300

Test Plan:

  • To set up pre-commit, run pip install pre-commit if you don't already have it, and then run pre-commit install in the project directory. Pre-commit hooks should now run automatically every time a new commit is made.
  • Ensure that pre-commit run --all-files passes for all files in the project.
  • Ensure that the GitHub action is successful

@mayankpatibandla mayankpatibandla changed the title Pylint ci ✨Add Pylint to GitHub actions Oct 25, 2023
@mayankpatibandla mayankpatibandla self-assigned this Oct 25, 2023
Copy link
Member

@ayushuk ayushuk left a comment

Choose a reason for hiding this comment

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

On hold, will be merged after the 3.5.0 release

@ayushuk
Copy link
Member

ayushuk commented Jan 22, 2024

@mayankpatibandla Can you solve the conflicts in the meantime?

@ayushuk ayushuk mentioned this pull request Jan 22, 2024
2 tasks
@ayushuk ayushuk added on hold This may be revisited in the future in progress This is currently being worked on labels Jan 22, 2024
@mayankpatibandla
Copy link
Member Author

Conflicts have been resolved

@ayushuk
Copy link
Member

ayushuk commented Jan 30, 2024

Lets wait to merge this after 3.5.1 since we want to get that out quickly and then when everything is stable again we can merge this and start enforcing it.

@mayankpatibandla mayankpatibandla mentioned this pull request Feb 2, 2024
3 tasks
@mayankpatibandla mayankpatibandla mentioned this pull request Mar 5, 2024
90 tasks
@mayankpatibandla mayankpatibandla changed the title ✨Add Pylint to GitHub actions ✨Add pre-commit and Pylint Mar 5, 2024
@mayankpatibandla mayankpatibandla changed the title ✨Add pre-commit and Pylint 🎨🚨 Add pre-commit and Pylint Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in progress This is currently being worked on on hold This may be revisited in the future
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants