Enforce comments on the codebase

[sedefsavas]

Enable linters for enforcing adding a comment to exported methods.

Relevant cluster-api PRs:
kubernetes-sigs/cluster-api#4631
kubernetes-sigs/cluster-api#4669

/milestone Next
/priority backlog
/good-first-issue
/help

[k8s-ci-robot]

@sedefsavas:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

Enable linters for enforcing adding a comment to exported methods.

Similar to this: kubernetes-sigs/cluster-api#4669

/milestone Next
/priority backlog
/good-first-issue
/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[Algebra8]

Hello 👋

So it seems like kubernetes-sigs's cluster-api uses golint, so it should be as simple as adding that to .golangci.yml.

Should certain files, packages, or code also be excluded, e.g. (func|type).*Fake.*, .*test/ etc? (examples taken from the issue posted).

[sedefsavas]

Hello @Algebra8!

Yes, wherever we don't need to add comments, we should exclude, e.g.,: *test, *fake, *mock, hack/.

After enabling this in golangci.yml, missing comments should be added as well, so expecting this to be a big PR.

[Algebra8]

Ah ok, thanks for the heads up! I will work on my fork and make a PR when I think it's ready. Just a heads up though, I am currently interviewing so I won't be able to put 100% of my time and get it done ASAP. Is that alright?

[sedefsavas]

Yes, we are 1 month away from the release. You can do a draft PR or WIP PR if you want feedback too.

/assign Algebra8

[Algebra8]

Great, thanks @sedefsavas !

[devopsy-ir]

/assign

[sedefsavas]

@mohsen-abbasi-shia Hi!
This issue was already assigned to @Algebra8, so unassigning you. We have other unassigned good-first-issues you can pick up.
/unassign @mohsen-abbasi-shia

[sedefsavas]

This is also relevant.
kubernetes-sigs/cluster-api#4631

[Algebra8]

This is also relevant.
kubernetes-sigs/cluster-api#4631

@sedefsavas Thanks for the resource! I'll make sure to include package X implements X comment requirements as well.

PS I think I'll be submitting a draft soon because there are a few things I would appreciate feedback/clarity on. Will be submitting the draft soon.

[Algebra8]

Also, just a quick update: It seems like kubernetes-sigs/cluster-api@0fb33bc swapped using golint for revive. I believe this is because golint has been archived and golangci-lint recommends swapping it with revive. So, I'll be using revive instead of golint as well, unless asked not to.

[Algebra8]

@sedefsavas

Hope you're doing well. I have a few questions that I would appreciate feedback on here.

I would appreciate if you could provide some feedback or point me in the direction of the whom I should be getting feedback from.

Thanks!