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

Implement lints to match internal linting behavior #455

Open
1 of 6 tasks
another-rex opened this issue Feb 11, 2025 · 2 comments
Open
1 of 6 tasks

Implement lints to match internal linting behavior #455

another-rex opened this issue Feb 11, 2025 · 2 comments
Assignees

Comments

@another-rex
Copy link
Collaborator

another-rex commented Feb 11, 2025

  • All exported structs or functions need to have a comment
  • Each library need one and only one comment about what this package does
    Our internal linters only expect this comment for just one of the package's files (so it'll complain if it's there for multiple files with package comments)
  • There needs to be a new line at the end of a file
  • TODOs should be associated with a buganizer number or GitHub issue number (Custom regex lint?)
    E.g. any line with // TODO:
    Must also include b/12345
    Or #123 in the same line
  • //nolint comments. The internal linter has been fixed to allow this.
  • Use "any" instead of "interface{}"
@cuixq
Copy link
Collaborator

cuixq commented Feb 12, 2025

also using "any" instead of "interface{}"

@cuixq
Copy link
Collaborator

cuixq commented Feb 14, 2025

I just fixed the internal linter to allow nolint directives so we don't need to worry about it any more.

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

No branches or pull requests

3 participants