Skip to content

QoL fix: client-side linting #21557

Open
Open

Description

It'd be nice to have some linters for some common mistakes that I can regularly run client-side. I notice that apiview does some validation, so maybe this is just instructions and extending:

  • Using internal types in public facing APIs
  • Using context.Background() instead of context.TODO() in examples
  • Using log.Fatal() + standard // comment in examples, no panic().
  • Copyright doc comments are set
  • Package doc comment exists for any exported packages
  • Comments properly document the error types that they return (otherwise it's hard to know that azcore.ResponseError, or azservicebus.Error exist).
  • (others)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    EngSysThis issue is impacting the engineering system.MQThis issue is part of a "milestone of quality" initiative.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions