Open jacobweinstock opened 2 years ago
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: https://github.com/golangci/golangci-lint/issues/456
Comments for exported names are not checked.
One option would be to add to golangci.yml:
golangci.yml
issues: exclude-use-default: false
1. 2. 3. 4.
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:
Expected Behaviour
Would it be possible to add linting for comments on exported names?
Effective Go states
golangci-lint issue: https://github.com/golangci/golangci-lint/issues/456
Current Behaviour
Comments for exported names are not checked.
Possible Solution
One option would be to add to
golangci.yml:Steps to Reproduce (for bugs)
1. 2. 3. 4.
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: