Add en version: PouchContainer工程质量实践 #83
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
starnop
reviewed
Aug 21, 2018
|
|
||
| As [PouchContainer](https://github.com/alibaba/pouch) is getting more and more stable and comprehensive, this scaling project has attracted many developers from different industries. As every developer's coding styles are quite different, the code reviewers have to take the responsibilities for not only ensuring performance and the correctness of logics, but more importantly, keeping a coherent coding style. A coherent coding style is always essential to a maintainable code base. Besides that, we may also pay attention to the test coverage rate as well as the application's stability. Think about this, how can we make sure the new code doesn't affect the existing features if we don't have a solid set of regression tests? | ||
|
|
||
| This article aims to share the recommended coding style for PouchContainer project, as well as some practical cases of unit testing in golong. |
starnop
reviewed
Aug 21, 2018
|
|
||
| ## 1.1 Golinter - the Linter for coherent code style | ||
|
|
||
| golong's syntax is simple by designed, plus there are lots of [Code Review](https://github.com/golang/go/wiki/CodeReviewComments) guides in the community, it makes almost all golang projects have a similar code style, and this hence avoids lots of meaningless arguments. Besides the community, PouchContainer also defines some specific rules to ensure styles among developers, which benefits the readability and maintainability of the code. For more details, please have a look [here](https://github.com/alibaba/pouch/blob/master/docs/contributions/code_styles.md#additional-style-rules). |
|
Please check for grammatical and spelling mistakes. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Ⅰ. Describe what this PR did
Add English version of PouchContainer工程质量实践 (PouchContainer Code Quality in Practice)
Ⅱ. Does this pull request fix one issue?
#66
Ⅲ. Describe how you did it
Ⅳ. Describe how to verify it
Ⅴ. Special notes for reviews