-
-
Notifications
You must be signed in to change notification settings - Fork 320
Add ADR for extracting unstable features #1505
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Extract Unstable Features for Initial Release | ||
|
||
* Status: accepted | ||
* Deciders: @gregsdennis @jdrosiers @bhutton | ||
* Date: 2024-05-08 | ||
|
||
Technical Story: | ||
|
||
@gregsdennis [proposed](https://github.com/json-schema-org/json-schema-spec/issues/1443#issuecomment-2099427543) that an ADR be created to document that unstable features be extracted before the stable release. | ||
|
||
Also the [SDLC proposal](https://github.com/orgs/json-schema-org/discussions/671) which lists features that need to be put into the proposal process. | ||
|
||
## Context and Problem Statement | ||
|
||
In creating a stable spec release, it's important that all included features are well-developed and their behaviors are finalized. As such, the following features will be extracted before the stable release. | ||
|
||
- `$vocabulary` - This feature is still in development. | ||
- Output formats - This feature is still in development. | ||
- `propertyDependencies` - This feature is not technically in the spec and should go through the proposal process. | ||
|
||
## Decision Drivers <!-- optional --> | ||
|
||
We can't publish a stable spec that contains unstable features. Thus we need to remove them. | ||
|
||
## Considered Options | ||
|
||
1. Extract unfinished features and put them through the proposal process. | ||
2. Complete the features before releasing the spec. | ||
|
||
## Decision Outcome | ||
|
||
Chosen option: Extract unfinished features and put them through the proposal process. | ||
|
||
This allows us to release a stable version of the specification while continuing to develop these features. | ||
|
||
### Positive Consequences <!-- optional --> | ||
|
||
* We can release a spec earlier that fulfills our users' needs. | ||
* We can continue to develop these features. | ||
|
||
### Negative Consequences <!-- optional --> | ||
|
||
* These feature will be considered experimental until their proposals are accepted. This may be a hindrance to adoption. | ||
|
||
## Pros and Cons of the Options <!-- optional --> | ||
|
||
### Extract unfinished features and put them through the proposal process | ||
|
||
* Good, because we can release a spec earlier that fulfills our users' needs. | ||
* Good, because we can continue to develop these features. | ||
* Bad, because these features are experimental now. | ||
|
||
### Complete the features before releasing the spec | ||
|
||
* Good, because the features will be ready to use when the spec releases. | ||
* Bad, because the spec may not release if we can't finalize the features. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.