Skip to content

Commit 7567910

Browse files
authored
Merge pull request #229 from qualcomm/docs/add-semver-guarantees
docs: add semver documentation
2 parents 1ab779d + b9f0893 commit 7567910

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

packages/docs/angular-docs/src/routes/developer-previews.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,17 @@ import {Badge} from "@qualcomm-ui/react/badge"
99
Some components are released in an experimental state. These components are typically ready for production use, but their APIs and behavior may change outside our normal Semver guarantees.
1010

1111
Look for the <Badge size="sm" emphasis="warning">Developer Preview</Badge> badge on the component's documentation page next to the title.
12+
13+
## Semver Guarantees
14+
15+
This library follows [Semantic Versioning](https://semver.org/) (`MAJOR.Minor.Patch`).
16+
17+
- **Patch** releases contain bug fixes. No public API changes are introduced.
18+
- **Minor** releases add new features and backwards-compatible changes. Existing APIs continue to work without modification.
19+
- **Major** releases may contain breaking changes to public APIs. These are documented in the release notes with migration guidance.
20+
21+
### Developer Preview Components
22+
23+
Developer Preview components are exempt from the guarantees above. Their APIs can introduce breaking changes in any **Minor** release. Consumers of these components should expect API churn between minor versions and review the changelog when upgrading.
24+
25+
Once a component graduates from Developer Preview, it follows the standard semver guarantees described above.

packages/docs/react-docs/src/routes/developer-previews.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,17 @@ import {Badge} from "@qualcomm-ui/react/badge"
99
Some components are released in an experimental state. These components are typically ready for production use, but their APIs and behavior may change outside our normal Semver guarantees.
1010

1111
Look for the <Badge size="sm" emphasis="warning">Developer Preview</Badge> badge on the component's documentation page next to the title.
12+
13+
## Semver Guarantees
14+
15+
This library follows [Semantic Versioning](https://semver.org/) (`MAJOR.Minor.Patch`).
16+
17+
- **Patch** releases contain bug fixes. No public API changes are introduced.
18+
- **Minor** releases add new features and backwards-compatible changes. Existing APIs continue to work without modification.
19+
- **Major** releases may contain breaking changes to public APIs. These are documented in the release notes with migration guidance.
20+
21+
### Developer Preview Components
22+
23+
Developer Preview components are exempt from the guarantees above. Their APIs can introduce breaking changes in any **Minor** release. Consumers of these components should expect API churn between minor versions and review the changelog when upgrading.
24+
25+
Once a component graduates from Developer Preview, it follows the standard semver guarantees described above.

0 commit comments

Comments
 (0)