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

Maintenance: Auto-style and format codebase #8

Closed
mbeacom opened this issue Jan 31, 2023 · 0 comments · Fixed by #9
Closed

Maintenance: Auto-style and format codebase #8

mbeacom opened this issue Jan 31, 2023 · 0 comments · Fixed by #9
Assignees

Comments

@mbeacom
Copy link
Contributor

mbeacom commented Jan 31, 2023

Summary

This codebase presently doesn't conform to PEP-8 or other styling guidelines common in the python community.
There are a number of capable tools to automatically style and format this python repository (e.g. black and isort) that could easily reduce the onus or guess work associated with handling this formatting.

Why is this needed?

More easily maintain the codebase and make OSS contributions more approachable.

Which area does this relate to?

Governance, Other

Solution

Execute the styling/formatting tools already setup in pyproject.toml dependencies.

e.g. execute poetry run black . and poetry run isort --profile=black . and instrument pre-commit to continuously enforce the standard.

@mbeacom mbeacom self-assigned this Jan 31, 2023
mbeacom added a commit to mbeacom/eks-cluster-upgrade that referenced this issue Jan 31, 2023
@bryantbiggs bryantbiggs linked a pull request Jan 31, 2023 that will close this issue
3 tasks
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.

1 participant