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

Adopt a code linter and/or formatter #227

Open
ctreatma opened this issue Sep 25, 2024 · 0 comments
Open

Adopt a code linter and/or formatter #227

ctreatma opened this issue Sep 25, 2024 · 0 comments

Comments

@ctreatma
Copy link
Contributor

SUMMARY

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.

ISSUE TYPE
  • Feature Idea
COMPONENT NAME
ADDITIONAL INFORMATION
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

No branches or pull requests

1 participant