From b91ddc4e298597ce36a8e2e07670b6077d617ec9 Mon Sep 17 00:00:00 2001 From: Greg Dennis Date: Mon, 25 Sep 2023 11:20:31 +1300 Subject: [PATCH 1/5] add proposal document template --- proposals/proposal-template.md | 88 ++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 proposals/proposal-template.md diff --git a/proposals/proposal-template.md b/proposals/proposal-template.md new file mode 100644 index 00000000..4bc8716a --- /dev/null +++ b/proposals/proposal-template.md @@ -0,0 +1,88 @@ +# JSON Schema Proposal: + +## Abstract + + + +This document proposes a change to the ??? specification by adding ???. + +## Note to Readers + + + +The issues list for this proposal can be found at +. + +For additional information, see . + +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 + + + +### Solution + + + +### Alternatives + + + +### Limitations + + + +### Examples + + + +## Proposal + +### Target for Change + + + +This proposal will add the {{???}} section contained herein as +a subsection of ???. + +### ??? + + + +## Champions + +| Champion | Company | Email | URI | +|----------------------------|---------|-------------------------|----------------------------------| +| Your Name | | | < GitHub profile page > | From 0e4d0d45ab6c986e29ec3e8d2848ff21273f3cf0 Mon Sep 17 00:00:00 2001 From: Greg Dennis Date: Thu, 5 Oct 2023 10:49:34 +1300 Subject: [PATCH 2/5] incorporated some changes from #1450 --- proposals/proposal-template.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/proposals/proposal-template.md b/proposals/proposal-template.md index 4bc8716a..91eb2e26 100644 --- a/proposals/proposal-template.md +++ b/proposals/proposal-template.md @@ -15,6 +15,16 @@ For example This document proposes a change to the ??? specification by adding ???. +## Status + +**Current Status**: PROPOSAL + + + + + ## Note to Readers + ### Alternatives @@ -55,13 +65,9 @@ also apply to this document. -### Examples +## Change Details - - -## Proposal - -### Target for Change +### Target -## Champions +## [Appendix] Change Log + +* [MMMM YYYY] Created + +## [Appendix] Champions | Champion | Company | Email | URI | |----------------------------|---------|-------------------------|----------------------------------| From 3967de6561eae36c7c0a9602054c8cfca6612d31 Mon Sep 17 00:00:00 2001 From: Greg Dennis Date: Tue, 14 May 2024 10:12:43 +1200 Subject: [PATCH 3/5] update instructions in 'status' section --- proposals/proposal-template.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/proposals/proposal-template.md b/proposals/proposal-template.md index 91eb2e26..4af949e7 100644 --- a/proposals/proposal-template.md +++ b/proposals/proposal-template.md @@ -15,15 +15,12 @@ For example This document proposes a change to the ??? specification by adding ???. -## Status +## Current Status -**Current Status**: PROPOSAL - - - - + ## Note to Readers @@ -57,10 +54,6 @@ also apply to this document. -### Alternatives - - - ### Limitations From ffdd2c3cb8690ea2c60ba56ca27fa45c400bb20a Mon Sep 17 00:00:00 2001 From: Greg Dennis Date: Tue, 14 May 2024 10:19:18 +1200 Subject: [PATCH 4/5] update process to include feature ADR --- PROCESS.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/PROCESS.md b/PROCESS.md index d9b93adb..c3b55a90 100644 --- a/PROCESS.md +++ b/PROCESS.md @@ -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: @@ -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. From d90219d295795765b309296d59a84673bf0e7cb9 Mon Sep 17 00:00:00 2001 From: Greg Dennis Date: Tue, 14 May 2024 11:12:28 +1200 Subject: [PATCH 5/5] update template to align with actual proposal --- proposals/proposal-template.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/proposals/proposal-template.md b/proposals/proposal-template.md index 4af949e7..62381696 100644 --- a/proposals/proposal-template.md +++ b/proposals/proposal-template.md @@ -19,7 +19,7 @@ This document proposes a change to the ??? specification by adding ???. ## Note to Readers @@ -60,26 +60,27 @@ also apply to this document. ## Change Details -### Target - -This proposal will add the {{???}} section contained herein as -a subsection of ???. - -### ??? - - - ## [Appendix] Change Log * [MMMM YYYY] Created