There is a lint task defined in the Makefile that uses pylint and mypy, but that task is never run in any CI jobs and it isn't mentioned in any documentation. The task also does not seem to work as written (pylint reports linting issues, but the subsequent mypy commands are not executed).
We should have a working task for linting and/or formatting of the code so that we notice when code in this repo doesn't align with standards and so that it is easy for contributors to address. We've previously discussed using the black Python formatter to automatically format code here in equinix-sdk-python, and that tool could also be used here.
SUMMARY
There is a
linttask defined in the Makefile that usespylintandmypy, but that task is never run in any CI jobs and it isn't mentioned in any documentation. The task also does not seem to work as written (pylintreports linting issues, but the subsequentmypycommands are not executed).We should have a working task for linting and/or formatting of the code so that we notice when code in this repo doesn't align with standards and so that it is easy for contributors to address. We've previously discussed using the
blackPython formatter to automatically format code here inequinix-sdk-python, and that tool could also be used here.ISSUE TYPE
COMPONENT NAME
ADDITIONAL INFORMATION