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 initial configs for coding standards. #58

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

inifares23lab
Copy link
Contributor

@inifares23lab inifares23lab commented Nov 28, 2023

Added pre commit config using ruff as linter and formatter.

About this change - What it does

Adds some basic configuration for git hooks using pre-commit framework.
Adds some basic configuration for ruff tool for linting and formatting python code.

Resolves: #25

Why this way

This project is a great testing ground for ruff. As opposed to more stable, battle-tested tools which one may choose for a production project (i.e.: black, flake, pylint, ..).
Ruff formatter is supposedly compatible with black formatter.
Ruff linter can use rules from many commonly used analyzers, parsers, linters.. (i.e.:pyflakes, isort, ..)

Added pre commit config using ruff as a linter and as a formatter.
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.

Adopt pylint and lint the existing modules
1 participant