DeepCycle icon indicating copy to clipboard operation
DeepCycle copied to clipboard

ci: static code analysis

Open AngryMaciek opened this issue 3 years ago • 1 comments

Having GitHub Actions mechanism running (as in #6 ) I would suggest to introduce a CI workflow which would run a static code analysis for python scripts; flake8 is a popular linter for python. That way you could ensure that the code inside the repository complies with the community standards. Example: here.

A Python code formatter might also be helpful: https://github.com/psf/black

AngryMaciek avatar Sep 16 '21 10:09 AngryMaciek

For every GH Action you can have a GH shield too and put it on top of the README. They automatically change colors and text depending on wheter the CI workflow is passing/failing. If you include static code analysis in this repo remember to add a flake8 shield as well!

Also, if you decide to use black formatter and like gathering shields like I do, they have their own: check here.

AngryMaciek avatar Sep 16 '21 11:09 AngryMaciek