Skip to content

Commit 26f0fcf

Browse files
authored
[chore] [docs/component-stability.md] Document relationship between versioning and stability (#11863)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Documents relationship between component stability and versioning. <!-- Issue number if applicable --> #### Link to tracking issue Fixes #11851
1 parent 8ac40a0 commit 26f0fcf

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/component-stability.md

+9
Original file line numberDiff line numberDiff line change
@@ -187,3 +187,12 @@ Components that were accepted based on being vendor-specific components will be
187187
they have no active code owners from the vendor even if there are other code owners listed. As part of being marked unmaintained, we'll attempt to contact the vendor to notify them of the change. Other active code
188188
owners may petition for its continued maintenance if they want, at which point the component will no
189189
longer be considered vendor-specific.
190+
191+
## Versioning
192+
193+
Components are Go modules and as such follow [semantic versioning](https://semver.org/). Go API stability guarantees are covered in the [VERSIONING.md](../VERSIONING.md) document.
194+
The versioning of the components applies to all signals simultaneously. For a component to be marked as 1.x it MUST be stable for at least one signal.
195+
196+
Even if a component has a 1.x or greater version, its behavior for specific signals might change in ways that break end users if the component is not stable for a particular signal.
197+
Go API stability guarantees apply to ALL signals, regardless of their stability level.
198+
This means that signal-specific configuration options MUST NOT be removed or changed in a way that breaks our Go API compatibility promise, even if the signal is not stable.

0 commit comments

Comments
 (0)