Skip to content
This repository has been archived by the owner on Apr 18, 2023. It is now read-only.

Next major version: Changes to consider #49

Open
knweiss opened this issue Apr 18, 2018 · 1 comment
Open

Next major version: Changes to consider #49

knweiss opened this issue Apr 18, 2018 · 1 comment

Comments

@knweiss
Copy link
Contributor

knweiss commented Apr 18, 2018

This issue is a wip collection of (compatibility-breaking) changes to consider for the next major version:

  • The package name currently is grpc_prometheus. However, the recommendation for Go package names is "Good package names are short and clear. They are lower case, with no under_scores or mixedCaps." Consequently golint complains:
client.go:6:1: don't use an underscore in package name
client_metrics.go:1:1: don't use an underscore in package name
client_reporter.go:4:1: don't use an underscore in package name
client_test.go:4:1: don't use an underscore in package name
metric_options.go:1:1: don't use an underscore in package name
server.go:6:1: don't use an underscore in package name
server_metrics.go:1:1: don't use an underscore in package name
server_reporter.go:4:1: don't use an underscore in package name
server_test.go:4:1: don't use an underscore in package name
util.go:4:1: don't use an underscore in package name
  • Consider unexporting the four constants in util.go (golint):
    util.go:16:2: exported const Unary should have comment (or a comment on this block) or be unexported
@bwplotka
Copy link
Collaborator

Thanks for this list, definitely package names might be something we should improve, but breaking compatibility is not great (:

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

No branches or pull requests

2 participants