add coding style documentation

Fix #9080

Signed-off-by: wang yan <wangyan@vmware.com>
This commit is contained in:
wang yan 2019-11-21 13:53:50 +08:00
parent f3f481dd12
commit cf6ef599e7

View File

@ -213,8 +213,8 @@ Write code on the new branch in your fork. The coding style used in Harbor is su
Try to limit column width to 120 characters for both code and markdown documents such as this one.
Always run [golint](https://github.com/golang/lint) on source code before
committing your changes.
As we are enforcing standards set by [golint](https://github.com/golang/lint), please always run golint on source code before committing your changes. If it reports an issue, in general, the preferred action is to fix the code to comply with the linter's recommendation
because golint gives suggestions according to the stylistic conventions listed in [Effective Go](https://golang.org/doc/effective_go.html) and the [CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments).
```
#Install fgt and golint