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

Code Quality in CI #360

Merged
merged 4 commits into from
Aug 7, 2024
Merged

Code Quality in CI #360

merged 4 commits into from
Aug 7, 2024

Conversation

mariugul
Copy link
Collaborator

@mariugul mariugul commented Jul 31, 2024

Code Quality

Introduced linting and formatting of the code. Used the most common tools from pre-commit and ran it on all the files. This is black formatter, isort import formatter, pylint, yaml, markdown formatters, unused imports ++. This is a cherry-pick from #359 + a commit to introduce the code quality to CI.

CI

Added a simple workflow to run this in CI on PR's. Haven't been able to test the CI run. T

Locally

hese code quality tools can also be run locally by adding it as a pre-commit hook or just running it manually.

This formatted python files with isort, black and ran
pylint linter.
It checked newlines at the end of files.
Formatted html, css, js.
Formatted Markdown and txt files.
Checked the shell scripts for shebangs.
No need to track private vs code settings.json in git.
@mariugul
Copy link
Collaborator Author

mariugul commented Aug 2, 2024

I was thinking that the CI will of course run as fail, because I only introduced the CI and I didn't format the files. So I pushed a commit to this PR where I formatted all the files by running the pre-commit tools. If the CI is green now I think this PR would be good to merge @vicwomg

@mariugul
Copy link
Collaborator Author

mariugul commented Aug 5, 2024

@vicwomg I can continue scoping out PR's once this is merged. Whenever you have the time to review it.

@vicwomg
Copy link
Owner

vicwomg commented Aug 5, 2024

@vicwomg I can continue scoping out PR's once this is merged. Whenever you have the time to review it.

Apologies, I have been traveling and have returned. Will be able to dedicate more time to this in the next few days

@mariugul
Copy link
Collaborator Author

mariugul commented Aug 6, 2024

@vicwomg I can continue scoping out PR's once this is merged. Whenever you have the time to review it.

Apologies, I have been traveling and have returned. Will be able to dedicate more time to this in the next few days

No worries!

@vicwomg vicwomg merged commit e33aee8 into vicwomg:master Aug 7, 2024
1 check passed
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