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

[Go] Updating a few guidelines and clarifying others #6903

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

richardpark-msft
Copy link
Member

  • errors should always be returned by pointer
  • NewClient and Client should be favored as the Client name (instead of WidgetClient, for instance)``

Richard Park added 2 commits November 9, 2023 12:03
- errors should always be returned by pointer
- NewClient and Client should be favored as the Client name (instead of WidgetClient, for instance)
JeffreyRichter
JeffreyRichter previously approved these changes Nov 10, 2023
Copy link
Member

@JeffreyRichter JeffreyRichter left a 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.

docs/golang/introduction.md Outdated Show resolved Hide resolved
docs/golang/introduction.md Outdated Show resolved Hide resolved
RickWinter
RickWinter previously approved these changes Nov 14, 2023
Copy link

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.

@github-actions github-actions bot added the no-recent-activity There has been no recent activity on this issue. label Jan 19, 2024
@RickWinter RickWinter dismissed stale reviews from JeffreyRichter and themself via 318baf1 January 22, 2024 17:45
Co-authored-by: Jeffrey Richter <jeffrichter@live.com>
@github-actions github-actions bot removed the no-recent-activity There has been no recent activity on this issue. label Jan 22, 2024
RickWinter
RickWinter previously approved these changes Mar 12, 2024
@mirusky
Copy link

mirusky commented Apr 7, 2024

Any plans of full guide for go?

@richardpark-msft
Copy link
Member Author

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)

@richardpark-msft richardpark-msft enabled auto-merge (squash) May 6, 2024 17:15
@RickWinter
Copy link
Member

@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.
Copy link
Member

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

@mirusky
Copy link

mirusky commented May 7, 2024

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.

@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.

Copy link

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.

@github-actions github-actions bot added the no-recent-activity There has been no recent activity on this issue. label Jul 12, 2024
@RickWinter
Copy link
Member

@richardpark-msft Can you get this across the finish line and checked in.

@github-actions github-actions bot removed the no-recent-activity There has been no recent activity on this issue. label Jul 18, 2024
Copy link

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.

@github-actions github-actions bot added the no-recent-activity There has been no recent activity on this issue. label Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-recent-activity There has been no recent activity on this issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants