Skip to content

Commit 340d28e

Browse files
add criteria to decide feature change preservation.
Signed-off-by: Siyuan Zhang <[email protected]>
1 parent ef2d3be commit 340d28e

File tree

1 file changed

+13
-4
lines changed
  • keps/sig-architecture/4330-compatibility-versions

1 file changed

+13
-4
lines changed

keps/sig-architecture/4330-compatibility-versions/README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -370,10 +370,19 @@ In order to preserve the behavior of in-development features across multiple rel
370370
feature implementation history should also be preserved in the code base instead of in place modifications.
371371
372372
Only sigificant and observable changes in feature capabilities should be across
373-
releases. We do not want to impose a unreasonable burdon on feature authors.
374-
Bugs, performance optimizations should not be gated by version.
375-
376-
Here are some examples of feature changes that should be or do not need not be preserved:
373+
releases. We do not want to impose a unreasonable burdon on feature authors.
374+
The main criteria to make the decision is:
375+
**Does this change break the contract with existing users of the feature?** i.e. would this change break the workloads of existing feature users if the user does not change the compatibility version?
376+
377+
Here are some common change senarios and whether the change needs to be preserved or not:
378+
* API change [Yes]
379+
* Change of supported systems [Yes]
380+
* Bug fix [No]
381+
* Performance optimizations [No]
382+
* Unstable metrics change [No]
383+
* Code refactoring [No]
384+
385+
Listed below are some concrete examples of feature changes:
377386
**Feature**|**Changes That Should Be Preserved**|**Changes That Do Not Need To Be Preserved**
378387
-----|-----|-----
379388
APIPriorityAndFairness | [add v1beta3 for Priority And Fairness](https://github.com/kubernetes/kubernetes/pull/112306) | [More seat metrics for APF](https://github.com/kubernetes/kubernetes/pull/105873)

0 commit comments

Comments
 (0)