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.

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

Consider enabling golangci-lint for this repo and enable the export comment linter. #372

Closed
mojtaba-esk opened this issue May 24, 2024 · 0 comments · Fixed by #402
Closed
Assignees
Labels

Comments

@mojtaba-esk
Copy link
Contributor

[follow up] we should enable golangci-lint for this repo and enable the export comment linter.

Why?

Exports should have comments so when other packages import them, it is abundantly clear what they are importing.

The additional benefit of having comments is that it forces line separation for things like this. So when 1 new error is added, we don't have an unnecessarily long diff that is unhelpful in understanding the actual change.

Copilot can add comments to all of these, so it isn't a big lift to add comments and new lines here in a separate PR.

Could be done now and merge to clean up the diff here.

Originally posted by @MSevey in #336 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

Successfully merging a pull request may close this issue.

2 participants