-
Notifications
You must be signed in to change notification settings - Fork 893
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
Update .golangci.yml file to include comments check rule #867
Conversation
.golangci.yml
Outdated
@@ -56,4 +56,4 @@ linters-settings: | |||
issues: | |||
# The list of ids of default excludes to include or disable. By default it's empty. | |||
include: | |||
- EXC0002 # disable excluding of issues about comments from golint | |||
- EXC0012 # disable excluding of issues about comments from revive |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there descriptions about the EXC0012
? Share a link?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have updated the comments, like EXC0002, the rule is disabled by default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How do you think the EXC0013
and EXC0014
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks helpful, we can include them too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can help us check whether our comments format is correct, eg:
pkg/util/helper/binding.go:35:1: exported: comment on exported type ClusterWeightInfoList should be of the form "ClusterWeightInfoList ..." (with optional leading article) (revive)
// ClusterWeightInfoListaa is a slice of ClusterWeightInfo that implements sort.Interface to sort by Value.
^
Signed-off-by: iawia002 <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/approve
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: RainbowMango The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Signed-off-by: iawia002 [email protected]
What type of PR is this?
/kind cleanup
What this PR does / why we need it:
Made a mistake in #806, now the comments check rule works fine.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?:
/assign @RainbowMango