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 static linter to workflows #85

Closed
meliache opened this issue Mar 24, 2021 · 1 comment · Fixed by #86
Closed

Add static linter to workflows #85

meliache opened this issue Mar 24, 2021 · 1 comment · Fixed by #86
Labels
enhancement New feature or request

Comments

@meliache
Copy link
Collaborator

At least for error-detection.

In #78 @nils-braun added github workflows and mentioned

This can be expanded to also include things like stylechecks (pycodestyle, autopep8, black), isort, flake8 etc - but so far let's start with the basics.

I think what can't hurt in any way is to at least add static syntax checking for errors with pyflakes (the error-part of flake8) or the error-detection of pylint. I'm not against going the extra step to do style checks, but that is a bit more work since it involves discussing which style we actually want (e.g. line length), defining it in a config file and also mentioning it in the documentation, so imo this could be split into a separate PR.

I have little experience with github workflows, but personally I have used pre-commit to do pre-commit checks locally. There's also a pre-commit action in the github marketplace and that would be my first idea how to implement style checks, since I find that extendible and straightforward and would feel confident of adding that myself. I just saw that there are also existing actions for e.g. flake8 that annotate the code, but I don't think we really need that. Or we could write our own actions. Don't know what's the most common approach.

@meliache meliache added the enhancement New feature or request label Mar 24, 2021
@nils-braun
Copy link
Owner

I would also go with pre-commit. I share your good experiences.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants