https://github.com/operator-framework/enhancements
https://github.com/operator-framework/enhancements
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/operator-framework/enhancements
- Owner: operator-framework
- License: apache-2.0
- Created: 2019-10-21T13:24:26.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-13T18:18:18.000Z (over 3 years ago)
- Last Synced: 2024-12-25T20:26:17.306Z (12 months ago)
- Size: 506 KB
- Stars: 9
- Watchers: 26
- Forks: 40
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Operator Framework Enhancements Tracking and Backlog
Enhancement tracking repository for Operator Framework.
Inspired by [Kubernetes
enhancements](https://github.com/kubernetes/enhancements) process.
This repository provides a rally point to discuss, debate, and reach consensus
for how Operator Framework [enhancements](./enhancements) are introduced.
Enhancements may take multiple releases to ultimately complete and thus provide
the basis of a community roadmap. Enhancements may be filed from anyone in the
community, but require consensus from domain specific project maintainers in
order to implement and accept into the release.
## Is My Thing an Enhancement?
A rough heuristic for an enhancement is anything that:
- impacts how a cluster is operated including addition or removal of significant
capabilities
- impacts upgrade/downgrade
- needs significant effort to complete
- requires consensus/code across multiple domains/repositories
- has phases of maturity (Dev Preview, Tech Preview, GA)
- demands formal documentation to utilize
It is unlikely to require an enhancement if it:
- fixes a bug
- adds more testing
- internally refactors a code or component only visible to that components
domain
- minimal impact to distribution as a whole
If you are not sure if the proposed work requires an enhancement, file an issue
and ask!
## When to Create a New Enhancement
Create an enhancement here once you:
- have circulated your idea to see if there is interest
- (optionally) have done a prototype in your own fork
- have identified people who agree to work on and maintain the enhancement
- many enhancements will take several releases to complete
## Why are Enhancements Tracked
As the project evolves, its important that the Operator Framework community understands how we
build, test, and document our work. Individually it is hard to understand how
all parts of the system interact, but as a community we can lean on each other
to build the right design and approach before getting too deep into an
implementation.
## When to Comment on an Enhancement Issue
Please comment on the enhancement issue to:
- request a review or clarification on the process
- update status of the enhancement effort
- link to relevant issues in other repos
Please do not comment on the enhancement issue to:
- discuss a detail of the design, code or docs. Use a linked-to-issue or PR
design for that