Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Enable exported comment checking #32

Open
jacobweinstock opened this issue Nov 2, 2021 · 0 comments
Open

Enable exported comment checking #32

jacobweinstock opened this issue Nov 2, 2021 · 0 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@jacobweinstock
Copy link
Member

jacobweinstock commented Nov 2, 2021 •
edited
Loading

Expected Behaviour

Would it be possible to add linting for comments on exported names?

Effective Go states

Every exported (capitalized) name in a program should have a doc comment.

golangci-lint issue: golangci/golangci-lint#456

Current Behaviour

Comments for exported names are not checked.

Possible Solution

One option would be to add to golangci.yml:

issues:
  exclude-use-default: false

Steps to Reproduce (for bugs)

Context

Your Environment

  • Operating System and version (e.g. Linux, Windows, MacOS):

  • How are you running Tinkerbell? Using Vagrant & VirtualBox, Vagrant & Libvirt, on Packet using Terraform, or give details:

  • Link to your project or a code example to reproduce issue:
@jacobweinstock jacobweinstock added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 2, 2021
@nshalman nshalman added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Nov 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nshalman @jacobweinstock