-
Notifications
You must be signed in to change notification settings - Fork 297
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
[Go] Updating a few guidelines and clarifying others #6903
base: main
Are you sure you want to change the base?
[Go] Updating a few guidelines and clarifying others #6903
Conversation
richardpark-msft
commented
Nov 9, 2023
- errors should always be returned by pointer
- NewClient and Client should be favored as the Client name (instead of WidgetClient, for instance)``
- errors should always be returned by pointer - NewClient and Client should be favored as the Client name (instead of WidgetClient, for instance)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm approving now but please address my comments.
Hi @richardpark-msft. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days. |
318baf1
Co-authored-by: Jeffrey Richter <jeffrichter@live.com>
Any plans of full guide for go? |
@mirusky, what kind of guide are you thinking of? This particular document is basically the "here's what Azure SDKs interface must look like" for Go, but not a tutorial/introduction to the language. We do have some learn.microsoft.com content (and more is always being added):
And each readme should contain links to our examples, for a particular package, on pkg.go.dev (for instance: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/messaging/azservicebus#pkg-examples) |
@jhendrixMSFT @JeffreyRichter Any more concerns with this change? Lets get this PR in to increase the value within our guidelines. |
@@ -74,17 +74,20 @@ Azure services will be exposed to Go developers as one or more _service client_ | |||
|
|||
Your API surface consists of one or more service clients that the consumer instantiates to connect to your service, plus a set of supporting types. | |||
|
|||
{% include requirement/MUST id="golang-client-naming" %} name service client types with the `Client` suffix. | |||
|
|||
{% include requirement/MUST id="golang-client-naming-onlyclient" %} name the client `Client`. The combination of the package and the type provide enough context. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some packages may have multiple clients in them and so we can't name them all Client
@richardpark-msft I mean, a full guideline for Azure Go SDK, the current guideline lacks many definitions and parts. Giving a ugly DX since it almost doen't have the concrete rules and explanations. |
Hi @richardpark-msft. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days. |
@richardpark-msft Can you get this across the finish line and checked in. |
Hi @richardpark-msft. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days. |