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

Adding CODE_STYLE.md and CODE_STYLE_CN.md for APISIX #1874

Merged
merged 3 commits into from
Jul 22, 2020
Merged

Adding CODE_STYLE.md and CODE_STYLE_CN.md for APISIX #1874

merged 3 commits into from
Jul 22, 2020

Conversation

yongboy
Copy link
Contributor

@yongboy yongboy commented Jul 20, 2020

What this PR does / why we need it:

We missing the apisix's lua code style guide when writing a plugin, fixing the code bug.

Pre-submission checklist:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible?

Summary

  1. Adding CODE_STYLE.md base on https://github.com/apache/incubator-apisix/blob/v1.2/CODE_STYLE.md, and change it for meeting APISIX project
  2. Adding CODE_STYLE_CN.md base on https://juejin.im/post/5d71f9bcf265da03b76b437c, and change it for readable :))
  3. Fixing the CODE_STYLE_CN.md invalid path bug within doc/zh-cn/README.md

Issues resolved

Fix #1846

@moonming
Copy link
Member

@yongboy

Scan detected 1 error(s) in 1 file(s):
  [./CODE_STYLE_CN.md]:
      20: line has trailing whitespace.

please fix the code style, which blocked CI.

@moonming moonming mentioned this pull request Jul 21, 2020
4 tasks
@yongboy
Copy link
Contributor Author

yongboy commented Jul 21, 2020

Removed line 20's trailing whitespace with the commit:
a0ae4c1

But the CI still tell me the error:

  [./CODE_STYLE_CN.md]:
      20: line has trailing whitespace.

Checking the CODE_STYLE_CN.md line 20, you can't find the trailing whitespace now:

image

What should I do now ?

@membphis
Copy link
Member

works fine at my local machine. I will rerun the Github Action.

Reading configuration file [.travis/ASF-Release.cfg]...
Scanning files starting at [./]...
All checks passed.

@moonming moonming merged commit 8fbd0ac into apache:master Jul 22, 2020
@membphis
Copy link
Member

@yongboy many thx

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 this pull request may close these issues.

bug: Missing the CODE_STYLE.md file
3 participants