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

[Question] Does OpenYurt have a formal code style requirement? #330

Closed
zzguang opened this issue May 31, 2021 · 2 comments
Closed

[Question] Does OpenYurt have a formal code style requirement? #330

zzguang opened this issue May 31, 2021 · 2 comments
Labels
kind/question kind/question

Comments

@zzguang
Copy link
Member

zzguang commented May 31, 2021

What happened:
I am not sure whether OpenYurt has a formal code style requirement, which may include:

  1. function name definition rule
  2. limitation of max characters every line
  3. code comments format
  4. patch comments format
  5. ...
    What you expected to happen:
    If no clear requirement for OpenYurt by now, I think it's better to clarify it so that different contributors can follow the unified code style rule. Forming the consistent code style may be beneficial to the code readability and maintainability of the whole project.
    How to reproduce it (as minimally and precisely as possible):

Anything else we need to know?:

Environment:

  • OpenYurt version:
  • Kubernetes version (use kubectl version):
  • OS (e.g: cat /etc/os-release):
  • Kernel (e.g. uname -a):
  • Install tools:
  • Others:

others
/kind question

@zzguang zzguang added the kind/question kind/question label May 31, 2021
@zzguang zzguang changed the title [Question] Does OpenYurt has formal code style requirement? [Question] Does OpenYurt have a formal code style requirement? May 31, 2021
@rambohe-ch
Copy link
Member

@zzguang Very appreciate for your issue.
OpenYurt community does not have a detailed code style at present, but code of pull request will be verified by golang native rule(golangci-lint run --out-format=github-actions --disable-all -E deadcode -E gofmt -E goimports -E ineffassign -E misspell -E vet --timeout=15m in github action)

and If you have a good code style to contribute to OpenYurt, we will be more than happy to do so.

@zzguang
Copy link
Member Author

zzguang commented Jun 7, 2021

Okay, let's follow the golang native rule firstly, if we find it's not enough yet, we can discuss it in future to figure out an unified code style, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/question kind/question
Projects
None yet
Development

No branches or pull requests

2 participants