Skip to content

add proposal document template #1449

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 5 commits into from
May 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,9 @@ At least two (2) Core Team members must have implemented prototypes before the c

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.

The proposal will use the [Proposal Template]() and be stored in this repository's `proposals` folder.
The proposal will use the [Proposal Template](./proposals/proposal-template.md) and be stored in this repository's `proposals` folder.

```diff
@@ TODO: Define Proposal Template and fill in the link. @@
```
Additionally, a draft ADR will be included using the file name of the proposal document with an `-adr` suffix: `{proposal-file-name}-adr.md`. This ADR will include additional information from the "Concept" discussion.

Proposed keywords will be added to the appropriate vocabulary meta-schemas in:

Expand Down Expand Up @@ -169,7 +167,9 @@ If a proposal cannot advance to the next stage, it may be removed. The proposal

### Stable

The proposal is incorporated into the specification in the `main` branch, and the feature will be required as of the next release.
The feature is incorporated into the specification in the `main` branch as specified by the proposal document, and the feature will be required as of the next release.

The draft ADR is completed, dated, and moved to the `adr` folder.

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.

Expand Down
92 changes: 92 additions & 0 deletions proposals/proposal-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# JSON Schema Proposal: <TODO>

## Abstract

<!--
Fill in the specification(s) that will change. If adding a keyword, which vocabulary
will contain it?

For example

This document proposes a change to the JSON Schema Core specification and
Applicator vocabulary by adding the `propertyDependencies` keyword.

-->

This document proposes a change to the ??? specification by adding ???.

## Current Status

<!--
Status is free text: just something to explain where the proposal is in
its journey. This status does not align with the SDLC feature life cycle.
-->

## Note to Readers

<!--
It would be a good idea to isolate the issues that discuss the feature by
updating the link below to include a query.
-->

The issues list for this proposal can be found at
<https://github.com/json-schema-org/json-schema-spec/issues>.

For additional information, see <https://json-schema.org/>.

To provide feedback, use this issue tracker or any of the communication methods
listed on the homepage.

## Table of Contents

## Conventions and Terminology

All conventions and terms used and defined by the JSON Schema Core specification
also apply to this document.

## Overview

### Problem Statement

<!-- What problem exists that needs solving? -->

### Solution

<!-- What is the solution? Include examples of use. -->

### Limitations

<!-- Are there any limitations inherent to the proposal? -->

## Change Details

<!--
This is where the specification changes are defined. This must be precise as
these changes will be made verbatim.

For example

1. The following section will be added to the JSON Schema Core specification as
a subsection of "Keywords for Applying Subschemas Conditionally".
> ### {New section name}
>
> {Feature description}
2. The following subschema will be added to the Applicator Vocabulary schema,
`https://json-schema.org/<version>/<release>/meta/applicator`, at
`/properties/{keyword}`:
```jsonc
{
// keyword schema
}
```
-->

## [Appendix] Change Log

* [MMMM YYYY] Created

## [Appendix] Champions

| Champion | Company | Email | URI |
|----------------------------|---------|-------------------------|----------------------------------|
| Your Name | | | < GitHub profile page > |
Loading