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 github workflows for checking contributing guidelines #163

Closed
1 of 2 tasks
ParthS007 opened this issue May 24, 2022 · 6 comments
Closed
1 of 2 tasks

Add github workflows for checking contributing guidelines #163

ParthS007 opened this issue May 24, 2022 · 6 comments

Comments

@ParthS007
Copy link
Contributor

ParthS007 commented May 24, 2022

  • Add pylint spec check

  • Add Black and flake8 check

I would like to work on it.

@jezdez
Copy link
Member

jezdez commented May 25, 2022

This has already partially been done via pre-commit and using pre-commit.ci. You may want to add a pylint pre-commit hook, if you'd like though.

@jezdez
Copy link
Member

jezdez commented May 25, 2022

Here's how it looked for #162:

CleanShot 2022-05-25 at 12 41 54@2x

@ParthS007
Copy link
Contributor Author

ParthS007 commented May 25, 2022

okay, thanks. I will add for pylint check 👍

@mattseymour
Copy link
Contributor

So I have no issue with pylint but we are running flake8 on the code base. But, will pylint really give us much more? Flake8 seems to be the goto tool for Jazzband projects. I worry it will be too strict and we will then start getting into configuration wars as each person has their own setup and way of doing things. Flake8 seems like a sensible compromise? What are your thoughts?

This is part of the reason flake8 was originally chosen as it seems to be a happy middle ground.

@ParthS007
Copy link
Contributor Author

I agree with having a minimal setup for configuration, I created the issue because it was mentioned here. We can go with having isort, black and flake8 only.

After running pylint, it shows some valid warnings which can be changed/improved without having the pre commit check as well and not to have strictness for config. I can work on them in a different PR and close this one?

@mattseymour
Copy link
Contributor

I think thats probably a good shout for the time being. Becuase the project is so small I think trying to keep to a simple core set (as in other jazzband projects) seems sensible. But certainly do target the valid issues you have foud in pylint. 👍🏾

@ParthS007 ParthS007 closed this as not planned Won't fix, can't repro, duplicate, stale May 28, 2022
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 a pull request may close this issue.

3 participants