Add ruff linter to improve code quality and maintainability #48
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adding linting aims to improve code quality and streamline reviews, making it easier for contributors to understand and maintain the codebase. I chose ruff due to its performance and comprehensive rule set that aligns with our project’s needs, making it a suitable choice over other linters. (https://realpython.com/ruff-python/)
Fixes #
Checklist
Please make sure that the following criteria are met:
README.mdin the example project directory, which describes the stack and includes instructions to deploy or test.website/docs/template-library/..which gets published to stackql-deploy.io (optional)Additional Notes
Currently, lint checks are run with ruff check . and tests require commands like pip install -e . for setup. In a future PR, I plan to simplify these with make lint and make test commands, enabling contributors to lint and test code more consistently. Feedback is welcome, especially if you think additional linters like flake8 should also be considered.