Skip to content

Commit ca04f7d

Browse files
committed
add proposal document template
1 parent 49e58a5 commit ca04f7d

File tree

1 file changed

+88
-0
lines changed

1 file changed

+88
-0
lines changed

proposals/proposal-template.md

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# JSON Schema Proposal: <TODO>
2+
3+
## Abstract
4+
5+
<!--
6+
Fill in the specification(s) that will change. If adding a keyword, which vocabulary
7+
will contain it?
8+
9+
For example
10+
11+
This document proposes a change to the JSON Schema Core specification and
12+
Applicator vocabulary by adding the `propertyDependencies` keyword.
13+
14+
-->
15+
16+
This document proposes a change to the ??? specification by adding ???.
17+
18+
## Note to Readers
19+
20+
<!--
21+
It would be a good idea to isolate the issues that discuss the feature by
22+
updating the link below to include a query.
23+
-->
24+
25+
The issues list for this proposal can be found at
26+
<https://github.com/json-schema-org/json-schema-spec/issues>.
27+
28+
For additional information, see <https://json-schema.org/>.
29+
30+
To provide feedback, use this issue tracker or any of the communication methods
31+
listed on the homepage.
32+
33+
## Table of Contents
34+
35+
## Conventions and Terminology
36+
37+
All conventions and terms used and defined by the JSON Schema Core specification
38+
also apply to this document.
39+
40+
## Overview
41+
42+
### Problem Statement
43+
44+
<!-- What problem exists that needs solving? -->
45+
46+
### Solution
47+
48+
<!-- What is the solution? -->
49+
50+
### Alternatives
51+
52+
<!-- What other options have been considered? (summary, not detailed) -->
53+
54+
### Limitations
55+
56+
<!-- Are there any limitations inherent to the proposal? -->
57+
58+
### Examples
59+
60+
<!-- How will this feature be used? -->
61+
62+
## Proposal
63+
64+
### Target for Change
65+
66+
<!--
67+
Where does this change go?
68+
69+
For example
70+
71+
This proposal will add the {{propertyDependencies}} section contained herein as
72+
a subsection of JSON Schema Core, section 10.2.2 "Keywords for Applying
73+
Subschemas Conditionally."
74+
75+
-->
76+
77+
This proposal will add the {{???}} section contained herein as
78+
a subsection of ???.
79+
80+
### ???
81+
82+
<!-- What is the text that will appear in the specification? -->
83+
84+
## Champions
85+
86+
| Champion | Company | Email | URI |
87+
|----------------------------|---------|-------------------------|----------------------------------|
88+
| Your Name | | | < GitHub profile page > |

0 commit comments

Comments
 (0)