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

[SDK] Code style enforcement #2442

Closed
numerology opened this issue Oct 20, 2019 · 7 comments
Closed

[SDK] Code style enforcement #2442

numerology opened this issue Oct 20, 2019 · 7 comments
Assignees
Labels
area/samples area/sdk area/testing lifecycle/stale The issue / pull request is stale, any activities remove this label. priority/p1

Comments

@numerology
Copy link

numerology commented Oct 20, 2019

As discussed offline, currently KFP does not adopt a consistent coding style on its Python side. This is not the best practice.

Here we propose to use yapf to help contributors to enforce Google python coding style. I will send out a PR for the yapf configuration. The default configuration does not work very well :(

Also, I propose to use pylint to check the coding style in Travis CI.

[Update 10/21] Since yapf does do much to docstring, docformatter is recommended to auto-lint the docstring if a contributor found it hard to pass pylint checks.

@numerology numerology self-assigned this Oct 20, 2019
@numerology
Copy link
Author

/area sdk
/priority p1

@numerology
Copy link
Author

/area testing
/area samples

@eterna2
Copy link
Contributor

eterna2 commented Oct 21, 2019

I would love to have mypy included too.

@numerology
Copy link
Author

I would love to have mypy included too.

Sounds good. However it seems like before we enforce mypy we need some additional works to make sure we can pass its tests

@Bobgy
Copy link
Contributor

Bobgy commented Oct 21, 2019

FYI, tracker issue for frontend part is #2406

@stale
Copy link

stale bot commented Jun 25, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the lifecycle/stale The issue / pull request is stale, any activities remove this label. label Jun 25, 2020
@stale
Copy link

stale bot commented Jul 2, 2020

This issue has been automatically closed because it has not had recent activity. Please comment "/reopen" to reopen it.

@stale stale bot closed this as completed Jul 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/samples area/sdk area/testing lifecycle/stale The issue / pull request is stale, any activities remove this label. priority/p1
Projects
None yet
Development

No branches or pull requests

4 participants