Skip to content

Commit

Permalink
Merge pull request #148 from open-feature/doc-statuses
Browse files Browse the repository at this point in the history
chore: add status badges
  • Loading branch information
toddbaert authored Oct 13, 2022
2 parents 73430ed + a5b7b28 commit 18d2f02
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions specification/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ Possible statuses are described below:

### Experimental

[![Status](https://img.shields.io/static/v1?label=Status&message=experimental&color=orange)](https://github.com/open-feature/spec/tree/main/specification#experimental)

Specification sections that are marked as `Experimental` contain functionality under active development. Breaking changes are allowed and may be made without deprecation notices or warnings with minor version updates. We recommend you use these features in experimental environments and not in production.

Put simply:
Expand All @@ -52,6 +54,8 @@ Put simply:
### Hardening

[![Status](https://img.shields.io/static/v1?label=Status&message=hardening&color=yellow)](https://github.com/open-feature/spec/tree/main/specification#hardening)

Sections marked as `Hardening` describe functionality with an emphasis on stabilizing existing requirements. Breaking changes require consensus by the [Technical Steering Committee](https://github.com/open-feature/community/blob/main/governance-charter.md#tsc-members) but may still be made with minor version updates. These features are suitable for use in production environments. Feedback is encouraged.

Put simply:
Expand All @@ -60,6 +64,8 @@ Put simply:
### Stable

[![Status](https://img.shields.io/static/v1?label=Status&message=stable&color=green)](https://github.com/open-feature/spec/tree/main/specification#stable)

Sections marked as `Stable` do not allow breaking changes without a major version update. They can be used in production with a high degree of confidence.

Put simply:
Expand Down

0 comments on commit 18d2f02

Please sign in to comment.