operator-framework / operator-framework/operator-controller
Establish home for v1.0.0 Go APIs
Open
Nobody has claimed this yet.
lifecycle/frozen
- Dominant language
- Go
- Stars
- 213
- Forks
- 85
- Avg merge
- 2d 1m
- Merged PRs (30d)
- 38
Description
Goals:
- Eliminate current and prevent future side effects of dependency imports when importing APIs. (for example: see https://github.com/openshift/enhancements/blob/master/dev-guide/api-conventions.md#no-functions)
- Put up barriers to breaking changes. Once we reach v1.0.0, we MUST avoid breaking changes.
Breaking changes include:
- Anything that causes the
go-apidiffjob to fail. (see separate issues related to moving non-API Go code to an internal tree). The APIs will remain exported, so thego-apidiffjob will ensure that our Go code defining the APIs is not breaking from a Go perspective. - Anything that would cause Kubernetes clients to experience a breaking change when interacting with instances of our CRD via the Kubernetes apiserver.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked API conventions and the repository's go-apidiff job, then review the related issues about moving non-API Go code to an internal tree. Determine where the v1.0.0 APIs should live and how both Go compatibility and Kubernetes apiserver compatibility will be checked. Done means the API location and enforceable barriers are established without breaking either client type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100