Skip to content

Commit b6c7a98

Browse files
committed
write up initial spec development/publication process
1 parent f8967bc commit b6c7a98

File tree

2 files changed

+169
-0
lines changed

2 files changed

+169
-0
lines changed

PROCESS.md

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
# JSON Schema Specification Development and Publication Process
2+
3+
## Purpose
4+
5+
This document describes the development and publication process for the JSON Schema specifications contained within this repository.
6+
7+
- [JSON Schema Core](./jsonschema-core.md)
8+
- [JSON Schema Validation](./jsonschema-validation.md)
9+
10+
## Definitions
11+
12+
### Defined Behavior
13+
14+
Some behaviors within JSON Schema may be explicitly or implicitly undefined by the specifications for various reasons. How to handle these behaviors is generally left to implementations.
15+
16+
A defined behavior is one that is fully defined by the specifications.
17+
18+
### Stability and Breaking Changes
19+
20+
Stability is defined using the level of compatibility between sequential releases. If all schemas which are written to one release produce the same defined behavior under the following release, then those releases are compatible, and the specification is said to be stable between them.
21+
22+
If an existing schema under the new release exhibits defined behavior that is contrary to defined behavior under the previous release, the new release is said to contain breaking changes and the specification is unstable between those releases.
23+
24+
If a new release fully defines a previously undefined (or under-defined) behavior, the new release is still considered compatible, even if it contradicts the decision of any particular implementation.
25+
26+
### Release
27+
28+
A release is any single publication of the JSON Schema specifications (as a group).
29+
30+
### Version
31+
32+
Consecutive releases which maintain compatibility with each other comprise a version.
33+
34+
## Release and Version
35+
36+
The JSON Schema specification will aim to publish annually on or about the first of January each year. Releases are identified by the year they are published.
37+
38+
When a new release contains breaking changes, that release begins a new version of JSON Schema.
39+
40+
The version will be identified as an integer, starting with `1` and incrementing as needed.
41+
42+
Stability will be prioritized when making changes to the specification. Breaking changes are undesired and should be avoided when possible.
43+
44+
## Publication
45+
46+
### Specifications
47+
48+
The specifications will be published on the JSON Schema website, https://json-schema.org/, using a path comprised of the version, year, and document name. For example,
49+
50+
```
51+
https://json-schema.org/1/2025/core.html
52+
https://json-schema.org/1/2025/validation.html
53+
```
54+
55+
### Meta-schemas
56+
57+
A release meta-schema will be published under the same path using `schema` as the file name.
58+
59+
```
60+
https://json-schema.org/1/2025/schema
61+
```
62+
63+
The meta-schema for the latest release in a version will also be published under the version path with `schema` as the file name.
64+
65+
```
66+
https://json-schema.org/1/schema
67+
```
68+
69+
The latest-release meta-schemas will be updated with proposals as indicated by the [Proposal section](#proposal) of this document.
70+
71+
```diff
72+
@@ These are merely publication URLs. The spec will define the `$id` values for the meta-schemas. @@
73+
```
74+
75+
## Feature Life Cycle
76+
77+
New features will progress through a sequence of stages before being added to the specification, and existing stable features must be formally deprecated before being removed. The stages of the life cycle, in order, are:
78+
79+
- Concept
80+
- Proposal
81+
- Experimentation
82+
- Stable
83+
- Deprecated
84+
- Removed
85+
86+
The flow through these stages is depicted below:
87+
88+
![Feature Life Cycle Flow](./feature-life-cycle.png)
89+
90+
### Concept
91+
92+
The feature life cycle begins with an idea expressed in a GitHub issue in this repository. Initial discussion may occur in Slack or another space, but the life cycle does not formally begin until a GitHub issue is created.
93+
94+
The discussion should cover how the feature could work, use cases, syntax, alternatives, whether it’s a breaking change, etc., with a goal of deciding rough requirements.
95+
96+
During this stage, members of the Core Team will implement private prototypes of the ideas expressed in the issue to get a feel for how it integrates with the stable features. Questions to address may include:
97+
98+
- Does the idea operate within the confines of existing JSON Schema evaluation processes, or does it define something new?
99+
- Is the idea merely a shortcut for some existing functionality (syntactic sugar), or does it solve a previously unsolvable problem?
100+
- What is the expected complexity for implementing the feature?
101+
102+
### Proposal
103+
104+
Once a rough consensus for the idea has been reached, a formal proposal will be written, separate from the specification, with the goal of precisely defining specification changes.
105+
106+
The proposal will use the [Proposal Template]() and be stored in this repository's `proposals` folder.
107+
108+
```diff
109+
@@ TODO: Define Proposal Template and fill in the link. @@
110+
```
111+
112+
Proposed keywords will be added to the appropriate vocabulary meta-schemas in:
113+
114+
- latest published release and
115+
- the `main` branch of this repository.
116+
117+
The subschema for the proposed keyword will contain only a `$comment` keyword indicating that the feature is experimental and containing a link to the proposal document. Aside from the `$comment` keyword, the subschema will be empty.
118+
119+
_This is done so that a proposed keyword is allowed but not validated as its syntax may change during the proposal/experimentation process. It also permits different implementations to support different variations of each proposal separately throughout this process. It will be up to the implementation to validate these keywords in accordance with their support._
120+
121+
Tests for the proposal are added to the JSON Schema Test Suite.
122+
123+
```diff
124+
@@ TODO: Identify a location within the test suite for proposals. @@
125+
```
126+
127+
### Experimentation
128+
129+
Once the initial proposal has been completed, implementations may begin to support the new feature.
130+
131+
Feedback from implementers and users are result in refinements to the proposal, which will then be updated in the implementations.
132+
133+
Breaking changes to a proposed feature MAY occur, but are highly discouraged.
134+
135+
In order to proceed to the next stage ([Stable](#stable)):
136+
137+
- at least five (5) implementations support the feature
138+
- there is sufficient evidence of use
139+
- no changes are requested for a period of six (6) weeks
140+
141+
```diff
142+
@@ TODO: Determine usage metrics. @@
143+
```
144+
145+
Experimental features are not considered to be interoperable across implementations.
146+
147+
If a proposal cannot advance to the next stage, it may be removed. The proposal document is moved to an `archive` subfolder, the keyword is removed from the meta-schemas, and any tests are moved to an `archive` subfolder. The removal of a non-stable feature is not considered a breaking change.
148+
149+
### Stable
150+
151+
The proposal is incorporated into the specification in the `main` branch, and the feature will be required as of the next release.
152+
153+
The appropriate vocabulary meta-schema in the `main` branch is updated to include a subschema that validates the feature's syntax requirements. This will be made available with the next release.
154+
155+
The published meta-schema (for the current release) will have the keyword removed.
156+
157+
The appropriate tests are incorporated into the main suite.
158+
159+
### Deprecated
160+
161+
If a feature is no longer useful, e.g. it has been replaced, it may be deprecated by indicating it as such in the specification.
162+
163+
Implementations must support deprecated features.
164+
165+
### Removed
166+
167+
A feature must have been published as deprecated for at least one release before it can be considered for removal.
168+
169+
Feature removal is considered a breaking change.

feature-life-cycle.png

28.6 KB
Loading

0 commit comments

Comments
 (0)