gateway-api icon indicating copy to clipboard operation
gateway-api copied to clipboard

Published 20 hours ago • verified publisher icon kubernetes-sigs

Publish policy on using generics in gateway-api

Open keithmattix opened this issue 3 years ago • 6 comments

What would you like to be added: With generics shipping in go1.18, the gateway-api project needs to have some kind of policy around when and how generics should be used. If upstream Kubernetes has a policy, we likely need to mirror it. If further discussion is needed, please use GitHub Discussions and/or Slack to engage members of the community.

Why this is needed: Generics are a very new Go feature, and the implications of using them in a large codebase/project are unknown. Thus, it will be useful for contributors to have guidelines for how to use generics in the gateway-api codebase.

/good-first-issue

keithmattix avatar Sep 14 '22 14:09 keithmattix

@keithmattix: This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-good-first-issue command.

In response to this:

What would you like to be added: With generics shipping in go1.18, the gateway-api project needs to have some kind of policy around when and how generics should be used. If upstream Kubernetes has a policy, we likely need to mirror it.

Why this is needed: Generics are a very new Go feature, and the implications of using them in a large codebase/project are unknown. Thus, it will be useful for contributors to have guidelines for how to use generics in the gateway-api codebase.

/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Sep 14 '22 14:09 k8s-ci-robot

I would like to work on this issue. But would need guidance as well /assign

akankshakumari393 avatar Sep 14 '22 15:09 akankshakumari393

Refs https://github.com/kubernetes/community/blob/master/sig-architecture/generics.md for the upstream Kubernetes policy, and https://github.com/kubernetes/kubernetes/issues/106846 as a specific attempt at introducing generics in a meaningful way.

FWIW I did previously introduce some trivial usage of generics in https://github.com/kubernetes-sigs/gateway-api/pull/1081

mikemorris avatar Sep 16 '22 00:09 mikemorris

We have a upstream Kubernetes policy in place for using generics, I think we should mirror it for single source of truth

akankshakumari393 avatar Sep 25 '22 06:09 akankshakumari393

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Feb 08 '23 04:02 k8s-triage-robot

Where are we at with this?

shaneutt avatar Mar 12 '24 16:03 shaneutt