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

Last pre-OSS changes #54

Merged
merged 5 commits into from
Oct 13, 2023
Merged

Last pre-OSS changes #54

merged 5 commits into from
Oct 13, 2023

Conversation

akshayjshah
Copy link
Member

  • Add release notes configuration
  • Re-word top-level GoDoc
  • NoOp -> Nop, following io.NopCloser and friends

Following the standard library's io.NopCloser and friends, use Nop-
instead of NoOp- as a prefix for do-nothing implementations of an
interface.
// or "ip6" for pure IPv6. This defaults to "ip" and assumes IPv6
// is suitable for your deployment.
resolver.NewDNSResolver(net.DefaultResolver, "ip4", 5*time.Minute),
),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the example here to be a little shorter and more self-explanatory. WDYT?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kind of liked showing the resolver option, though perhaps the associated comment is unclear why it's useful to show. I suspect the resolver is the most likely thing people would need to tweak, but I could be wrong 🤷. Anyhow, new example is fine, too.

// or "ip6" for pure IPv6. This defaults to "ip" and assumes IPv6
// is suitable for your deployment.
resolver.NewDNSResolver(net.DefaultResolver, "ip4", 5*time.Minute),
),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kind of liked showing the resolver option, though perhaps the associated comment is unclear why it's useful to show. I suspect the resolver is the most likely thing people would need to tweak, but I could be wrong 🤷. Anyhow, new example is fine, too.

@@ -0,0 +1,16 @@
changelog:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this belong in our oss skeleton? Does this mean we also need to setup standard labels in every oss repo and to also label every PR to get the items correctly categorized into sections?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I'll put it into the skeleton! I'm not sure how to automate the label creation though. We don't need to label all the PRs - normally, I clean up the release notes and sort things by hand.

@akshayjshah akshayjshah merged commit 10e990c into main Oct 13, 2023
4 checks passed
@akshayjshah akshayjshah deleted the ajs/oss branch October 13, 2023 15:19
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

Successfully merging this pull request may close these issues.

2 participants