From cf6ef599e77b5c910f385aef3515268b2e338f21 Mon Sep 17 00:00:00 2001 From: wang yan Date: Thu, 21 Nov 2019 13:53:50 +0800 Subject: [PATCH] add coding style documentation Fix #9080 Signed-off-by: wang yan --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71b75b119..7b61acba5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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