json-schema-spec icon indicating copy to clipboard operation
json-schema-spec copied to clipboard

Core: Add section to define expectations for proposals

Open gregsdennis opened this issue 11 months ago • 6 comments

We need a section in Core that defines what we expect from tooling around support for feature proposals.

Basically, proposals are OPTIONAL but RECOMMENDED.

Tooling must also specify in their docs which proposals they support and the latest date or some kind of proposal version that they support.

gregsdennis avatar Jan 07 '25 17:01 gregsdennis

can i work on this issue ?

abhayymishraa avatar Jan 07 '25 18:01 abhayymishraa

@abhayymishraa if you have ideas, simply state them. You don't need permission to participate in discussion. However, as you can see under the "Projects" header to the right, this is still in discussion; it's not ready to be worked on.

Secondly, spec changes require in-depth knowledge of JSON Schema and experience with specification authorship. That generally means TSC members and other experts who have been working with JSON Schema for a long time and have proven their understanding of the spec and knowledge of its uses. While anyone may contribute their ideas to discussions, contribution to the documents is not generally open.

gregsdennis avatar Jan 07 '25 18:01 gregsdennis

got it...

abhayymishraa avatar Jan 07 '25 19:01 abhayymishraa

@json-schema-org/spec-team I'm having a hard time deciding whether this should go into the spec. On one hand, it is defining expectations. On the other, an implementation isn't necessarily required to support proposals.

Maybe this should go in a supporting project document similar to PROCESS.md.

I could use some other opinions.

gregsdennis avatar Jun 07 '25 23:06 gregsdennis

This doesn't sound like something that would go into the specification itself. I can't think of other specifications that talk much about implementations at all, let alone future-looking changes that aren't reflected in the spec yet.

A separate document sounds good -- it can talk about how new feature proposals progress through various statuses and eventually make it into the spec, and our expectations/desires for implementations with respect to specification compliance (including the formal test suite, bowtie, etc) as well as new proposed features. Thinking of recent discussions about "reference implementations", this might be a good place to mention what we expect from a fully-compliant implementation.

karenetheridge avatar Jun 08 '25 16:06 karenetheridge

I agree with Karen. To me, this is belongs in documentation about our spec development process. However, we should provide a reference to the process in the spec, which I don't remember if we've done yet.

jdesrosiers avatar Jun 10 '25 22:06 jdesrosiers

Okay. So the action here is to include a pointer to the spec process in Core.

gregsdennis avatar Jun 22 '25 00:06 gregsdennis

I imagine at some point there will be a folder with the proposals in, and in that folder will be a README.md, which will include the requirements details.

Relequestual avatar Jul 15 '25 11:07 Relequestual

@Relequestual we already have a proposals folder.

gregsdennis avatar Jul 16 '25 00:07 gregsdennis