docs: polish code style document for pouch #1283
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Allen Sun allensun.shl@alibaba-inc.com
Ⅰ. Describe what this PR did
This pull request tries to polish the code style document of project Pouch. These code styles should be followed when contributors are collaborating in this open source project. We will encourage every contributor to read this code style document first, and then do the code change.
In this pull request, I put forward the following 10 code style rules which are additional:
In addition, I do not think we should include markdown lint rule in https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md010---hard-tabs .
I think both tabs and whitespaces are valid here. cc @HusterWan
Ⅱ. Does this pull request fix one issue?
none
Ⅲ. Describe how you did it
make code style document more readable and more specific.
Ⅳ. Describe how to verify it
none
Ⅴ. Special notes for reviews
none