Require comments on exported funcs #996
Merged
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
k8s-ci-robot
added
release-note
k8s-ci-robot
added
sig/cluster-lifecycle
mboersma
commented
Oct 14, 2020
| # Run with --fast=false for more extensive checks | ||
| fast: true | ||
| issue: | ||
| issues: |
There was a problem hiding this comment.
The parser in golangci-lint seems to silently ignore typos like this (should have been issues:, so this section was being ignored.
mboersma
commented
Oct 14, 2020
| max-same-issues: 0 | ||
| max-per-linter: 0 |
There was a problem hiding this comment.
And this should have been max-issues-per-linter--fixed now.
mboersma
commented
Oct 14, 2020
mboersma
force-pushed
the
comments-required
branch
3 times, most recently
from
05611ca to
3fd7335
Compare
mboersma
commented
Oct 14, 2020
| @@ -28,6 +28,7 @@ const ( | |||
| // // alpha: v1.X | |||
| // MyFeature featuregate.Feature = "MyFeature" | |||
|
|
|||
| // AKS is the feature gate for AKS managed clusters. | |||
There was a problem hiding this comment.
@alexeldeib is it ok to add this to the top of feature gate doc comments?
mboersma
force-pushed
the
comments-required
branch
from
3fd7335 to
d0494d2
Compare
CecileRobertMichon
approved these changes
Oct 15, 2020
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: CecileRobertMichon 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 |
k8s-ci-robot
added
the
approved
3 tasks
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.
What type of PR is this?:
/kind cleanup
What this PR does / why we need it:
Turns on
golintchecking for comments on exported code objects inmake lint, and backfills 50+ comments to allow this PR to pass.Also fixes some typos in the
golangci-lintconfiguration and updates that tool to version 1.31.0.Which issue(s) this PR fixes:
Fixes #948
Special notes for your reviewer:
This doesn't guarantee "non-trivial" comments as suggested in #948, but seems like a good start to me.
I did my best to backfill missing comments, but would love help from reviewers with more history and context to make them better.
TODOs:
Release note: