Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add additional document statuses #139

Merged
merged 5 commits into from
Oct 12, 2022
Merged

chore: add additional document statuses #139

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e2629c1
add additional document statuses
toddbaert Sep 22, 2022
3b800fd
add more explanation, TSC approval
toddbaert Oct 5, 2022
73e1ed6
more description to stable
toddbaert Oct 5, 2022
29d6378
lint errors
toddbaert Oct 5, 2022
ed9a4bc
remove mixed
toddbaert Oct 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions specification/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,39 @@ An implementation is not compliant if it fails to satisfy one or more of the "MU

## Document Statuses

| Status | Explanation |
| -------------------- | ----------------------------- |
| No Explicit "Status" | Equivalent to Experimental. |
| Experimental | Breaking changes are allowed. |
Documents and subsections within the specification are marked with statuses indicating their stability level.
Functionality described in the specification graduates through these statuses with increasing stability.
Stability levels apply only to normative sections within the specification; editorial changes to examples and explanations are exempt from these constraints.
It is the responsibility of the [Technical Steering Committee](https://github.com/open-feature/community/blob/main/governance-charter.md#tsc-members) to consider and approve the graduation of documents.

Possible statuses are described below:

### Experimental

Specification documents 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:

> We're testing these features out. Things could change anytime.

### Hardening

Documents 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:

> We believe these features are ready for production use, and hope for feedback.

### 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:

> These features are stable and battle-hardened.

### Mixed

Specification documents marked as `Mixed` contain subsections of varying statuses specified above.
toddbaert marked this conversation as resolved.
Show resolved Hide resolved

NOTE: No explicit status = `Experimental`