-
-
Notifications
You must be signed in to change notification settings - Fork 52
The JSON Schema Charter #325
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
base: main
Are you sure you want to change the base?
Changes from 20 commits
0b8d59b
4666a22
3cc72d2
b7de5e1
a4bf147
327b09e
cdc7cf5
d60d388
ece5e53
2d38695
29ed1a5
c9a6006
d0d58ba
0c0f97c
557c0a2
5abe1bd
9ba125a
9301be9
e3ecb1e
f6ac84c
a2af3ba
3fc951e
df8930a
cfa2ae9
a6bc2a8
d30322d
fea1163
14d7ca2
90896a9
dc3785a
c35d423
c1f0fa4
42e1c54
1b31445
9634a60
8f1df0f
f5dd0f5
d083f46
6653e46
c84610a
a4943cd
94d1801
c9ab2dd
b5f0e85
b2efdce
d2f853c
035ab9b
dc3e685
631db8c
8eb9883
341ecef
f4e35ff
e94c0cb
9e1ad26
52bedb3
4a2ad4a
397a8d1
d79198e
59deddb
f1974e2
c872a5f
a974117
86ff12e
55aa9b3
75542a8
aea0b80
fbe8b54
63cf673
a996e13
2a92249
58d942b
8b2ed66
be38006
4c92fc6
507246b
26f9265
31d5f6e
47a0d79
37eccb2
bea5924
91d5133
cdce30b
06240f9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,196 @@ | ||
# JSON Schema Org Charter | ||
<!-- This document is managed in the json-schema-org/.github GitHub repository. Please do NOT modify this file in another repository as changes may be overridden. --> | ||
|
||
<!-- While this document is being written, you can find the discussion to help determine what should be found here at https://github.com/json-schema-org/community/discussions/286 - This comment should be removed before merging --> | ||
|
||
## Section 0: Guiding Principles | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<!-- https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391241 --> | ||
|
||
The JSON Schema project is part of the OpenJS Foundation which operates transparently, openly, collaboratively, and ethically. We strive to be open and transparent as much as is possible, and wish to enable anyone to interact and engage with any area of our work. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Having no structure in place usually leads to one that is informal and undocumented, making it difficult to meet our own expectations of how we wish to operate. As such, we define the following charter which includes aspects of the governance model to which we subscribe and by which we operate. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Section 1: Scope | ||
<!-- https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391250 --> | ||
|
||
JSON Schema aims to enable the confident and reliable use of the JSON data format. It does this primarily by providing specification documents which define a declarative language that allows annotation and validation of JSON documents. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I would change this to "reliable use of data expressed in the JSON format, other formats compatible with the JSON document model". JSON Schema isn't about the JSON data format itself, but about describing data expressed with that format, as well as others. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. While initially thinking about this, I thought I agreed, however on reflection, I'm not sure I do. It's not in scope of JSON Schema to care about other languages which "compile" to JSON, such as YAML.
I think this is only partially true. JSON Schema can only cater to a subset of YAML for example. It's possible to roundtrip from JSON to YAML to JSON, but not always possible to roundtrip from YAML to JSON to YAML. The use of "JSON data format" was used in effort to convey the "in memory" materilization of the data, as opposed to just a JSON file. I agree that "eliable use of data expressed in the JSON format" may make this clearer, however I'm not convinced about "other formats compatible with the JSON document model". "compatible" in what way? Do you have any additional thoughts on this? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I feel like the existing wording focuses on the JSON format itself, suggesting that we're doing syntax checking of JSON files. But actually, we're starting with a presumption of valid JSON, and working with data presented in that format instead. How about "data presented in the JSON format"? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "data that can be expressed in the JSON format"? We're built on the data model, and I think this opens it up to other formats that are translatable to JSON. |
||
While JSON Schema's primary target is constraint-based data validation, it continues to be used across the whole stack, in different stages of a given project, and for purposes beyond its original design. We aim to enable these additional and emergent use cases. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 1.1: In-scope (optional) | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391253 | ||
|
||
_directions: list or bullet out problem spaces, use cases, repositories_ | ||
_or other projects which are included with the work but may not be readily_ | ||
_apparent. This may help differentiate the project from other solutions in the_ | ||
_space. If you are not using this section, please indicate your intent with the_ | ||
_phrase, 'Section Intentionally Left Blank'._ | ||
|
||
ex. [K8s SIG Architecture Charter](https://github.com/kubernetes/community/blob/HEAD/sig-architecture/charter.md#in-scope) | ||
|
||
### 1.2: Out-of-Scope (optional) | ||
<!-- https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391262 --> | ||
|
||
Section Intentionally Left Blank | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Section 2: Relationship with OpenJS Foundation CPC. | ||
<!-- https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391266 --> | ||
|
||
Most large, complex open source communities have both a business and a technical governance model. Technical leadership for the projects within the OpenJS Foundation is delegated to the projects through their project charters by the OpenJS Cross Project Council (CPC). In the case of the JSON Schema project, it is delegated to the JSON Schema Technical Steering Committee ("TSC"). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove OpenJSF |
||
|
||
### 2.1 Other Formal Project Relationships (optional) | ||
<!-- https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391271 --> | ||
|
||
Section Intentionally Left Blank | ||
|
||
## Section 3: JSON Schema Org Governing Body (TSC) | ||
<!-- https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391284 --> | ||
|
||
The TSC is initially established from the observed major contributors who are currently active and in good standing. | ||
|
||
There is no maximum TSC membership size. The TSC must have a minimum of four members. | ||
|
||
Changes to TSC membership should be posted in the agenda, and may be suggested as any other agenda item. | ||
|
||
TSC memberships are not time-limited. | ||
|
||
While the project is not looking to obtain "Impact" project status within the OpenJS Foundation, there is no requirement set out to limit the number of TSC members by employer. It is in some cases considered difficult or even unhelpful for the project to limit the number or percentage of TSC members by employer (Especially when an employer has employed individuals already active in the community to work exclusively on the open source project). While at this time there is no limits on TSC membership by employer, the TSC will strive to keep to at least less than 50%, ideally 33% (One third, one in three). The TSC will re-evaluate this specific clause at least every six months, and aim to revise it within one year to meet the "no more than 1/3 employer member affiliation" mandate. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
TSC members are expected to regularly participate in TSC activities. | ||
|
||
The TSC will meet regularly using virtual conferencing tools. The meeting will be directed by the TSC Chairperson(s). Responsibility for directing individual meetings may be delegated by a TSC Chairperson to any other TSC member. Minutes or an appropriate recording will be taken and made available to the community through accessible public postings. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The TSC may, at its discretion, invite any number of non-voting observers to participate in the public portion of TSC discussions and meetings. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd encourage you to make those sessions public all the time. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's the intent! Public as much as possible! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Whereby I meant that the session should be public by default (with an agenda and videoconf link made available upfront), not that it is private by default and that the TSC may decide to open it. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Agreed. That is what is intended. If it doesn't come across that way, it needs revising. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this sentence is correct. It should be specified somewhere else that there might a private portion of the meeting. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Well, but the problem of making allowing access to the TSC meeting at the discretion of the TSC, is that this makes the meeting private by default, and requires action by the TSC to make it public. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It doesn't say that. It says the TSC may invite people to the public portion of the meeting. You're reading into it something which isn't there. Technically, as it is public, and the details of how to access it will be public, anyone could invite anyone. But I wanted to make it explicit that TSC may invite guests. I don't recall specifically where I borrowed the phrasing from, but I agree it is not clear and can be improved. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I dont doubt your intentions. I’m stating that the text doesn’t match them. ;) |
||
|
||
A TSC member may be removed by vote from the TSC if, during a 3-month period, all of the following are true: | ||
|
||
- They attend fewer than 25% of the regularly scheduled meetings | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- They do not participate in any TSC votes | ||
- They do not provide any form of excuse or no excuse is known for their absence | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Any restrictions on the maximum percentage of Governing Body members that can be employed by the same company? The risk of one company exerting undue influence over the direction of the project is real. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We looked at this before, I but I don't remember (or necessarily agree with) why it was removed. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This clause was seen more as a governance concern than a charter related concern, and was moved out to #456, specifically this line. (This also allows us to update it without having to go back to the OpenJS Foundation for their approval.)
I hear you. Regardless of what anyone in such a position reports, such as no to little influence, that doesn't mean things can't change, or it shouldn't be a concern. We are trying to start addressing this by engaging more with implementers: #412 - Comments and suggestions welcome. Additionally, we are looking to encourage users to self report: #441 Further, there are plans to create a stakeholders group: Community and DevRel Plan (view) (Although these are a little vague currently). Open to thoughts, suggestions, comments, on all of this and anything else that comes to mind as to how we can expand our TSC. @karenetheridge your voice carries weight here =] There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think this presents an immediate problem anymore, but I do think it's still a good idea to have such a limitation. |
||
## Section 4: Roles & Responsibilities | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<!-- https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391286 --> | ||
|
||
The JSON Schema project is jointly governed by a Technical Steering Committee (TSC) which is responsible for high-level guidance of the project. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The TSC has final authority over this project including: | ||
|
||
- Technical direction | ||
- Project governance and process (including this policy) | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Contribution policy | ||
- GitHub repository hosting and administration | ||
- Establishment of and delegation to working groups or teams | ||
- Mediating technical conflicts | ||
|
||
### Section 4.1 Project Operations & Management (optional) | ||
<!-- https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391290 --> | ||
|
||
The TSC and entire technical community will follow any processes as may be specified by the OpenJS Foundation Board relating to the intake and license compliance review of contributions, including the OpenJS Foundation IP Policy. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Section 4.2: Decision-making and Voting | ||
<!-- https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391296 --> | ||
Note: See comments found in raw view... | ||
|
||
The TSC follows a formal consensus seeking decision making model. | ||
benjagm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
In some situations, a vote may be preferable, however a vote will not be used to make the vast majority of decisions. | ||
In the unlikely case where it seems that consensus cannot be reached after multiple attempts, the decision process may be moved to resolve via a vote. This is not expected to happen, but defined as a backup. | ||
|
||
#### Decision-making via consensus | ||
|
||
When a TSC member looks for an issue to be discussed and a decision to be made, they must start by assessing if they feel it warrants potentially being a non-public discussion and decision. The TSC member must reach out to the TSC chairs to request a non-public discussion and decision. A discussion and decision will be non-public at the discretion of the TSC chairs. It is expected that decision discussions and voting will only be non-public in rare circumstances. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd suggest:
|
||
|
||
A decision discussion may be started by creating a Discussion in the Community repository. | ||
--? Should we have a new repo and limit the Discussions to that repo? TSC? ?-- | ||
The Discussion should include introductory information about the decision that needs to be made. It should follow the provided template, and must have the label `tsc-decision`. | ||
|
||
##### Quick consensus process | ||
|
||
In the event a TSC member feels the need for a decision to be expedited, they may create the decision discussion, indicating that they wish to use the quick process rather than the standard consensus process. | ||
|
||
A vote is called to see if other members agree. The vote takes place on the opening comment. This vote is different from the decision-making voting process, and only requires 3 (additional) votes in favour and none against to carry. If the vote carries, the quick process is started, otherwise the standard consensus process is started. | ||
|
||
The quick process is designed for small trivial issues where the resolution feels likely obvious, and the member who proposes the decision discussion has at least one clear resolution to present. The decision discussion owner should present the possible solution they are advocating for, and ask to test for agreement. If consensus is not clearly reached, the quick process is ended and the standard consensus process is started. | ||
|
||
##### Standard consensus process | ||
|
||
The standard consensus process is designed for all non-trivial decisions. | ||
The standard consensus process should progress through the following seven stages. | ||
|
||
1. Introduction and clarify the issue | ||
2. Open the discussion - Share needs and perspectives on the issue | ||
3. Explore ideas in a broad discussion | ||
4. Form a proposal | ||
5. Amend the proposal | ||
6. Test for agreement | ||
7. Determine resolution | ||
|
||
(These stages are those defined by the [Seeds For Change's Consensus Decision Making document](https://seedsforchange.org.uk/consensus). Please use that document as a rough guide for specific steps while we test and firm up our specific requirements, and document them in our [Governance document](./GOVERNANCE.md)) | ||
<!-- GOVERNANCE.md is not yet created. I would suggest that creating one which helps us through the seven stages of the consensus process be the first order of business. --> | ||
|
||
All decisions that go through the standard consensus process must also have an associated GitHub Discussion, which allows those unable to attend meetings to participate. | ||
The opening comment of the Discussion should be kept up to date as to the status of a decision. | ||
|
||
Transition between stages may be requested by anyone, but must be called by the facilitator (either a TSC chair or TSC member delegated the facilitator role for a given decision discussion). The stage will be indicated in the opening comment of the discussion and using the appropriate label. | ||
|
||
Most of the discussion should happen within the same Discussion. Groups looking to form a proposal or amend a proposal (stages 4 and 5) may make use of other additional Discussions or Issues, but these must be clearly linked. The opening comment should be updated to include links to relevant specific threads and comments in the same Discussion, and any other relevant locations. | ||
|
||
Moving to the 'Form a Proposal" stage should be approached when the group might feel able to combine ideas to form a single proposal. Multiple possible solutions should be discussed in the previous stage. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The "Test for Agreement" step is not voting, and is in stead asking for "signals", which enable the consensus process to continue. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Voting should be considered a last resort if the consensus process has failed for a particular issue, to enable the project to move forward. | ||
|
||
If someone calls for a Test of Agreement, the facilitator for the Discussion will review current proposal and may call to Test for Agreement. The facilitator will post a comment on the Discussion (using the provided template), linking to the current version of the proposal, and update the opening comment with a link to the new comment. TSC members will then be asked to signal their agreement using GitHub Reactions on the comment. | ||
|
||
The "Determine resolution" step should result in the creation of an [Any Decision Record](./docs/adr/README.md). More details in following sections. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
#### Decision-making via vote | ||
|
||
Any call for public TSC votes will be made by creating an Issue in the community repo with the `tsc-vote` label assigned. The Issue should use the provided template. | ||
--? Should public votes go in the community repo or a new TSC repo?-- | ||
|
||
Once an Issue gains the label `tsc-vote`, all members of the TSC will be notified via a specific Slack channel (and by any additional method the TSC deems helpful). The votes will be collected by way of using GitHub Reactions on a specific comment, which must not be the first comment. The first comment must link to the voting comment in the same Issue. | ||
Voting will by default close after 7 days. Any member of the TSC may request a 7 day extension for any reason, moving the closing date back by 7 days. Any member of the TSC may request additional extensions, approved at the discretion of any TSC chair. | ||
|
||
For a vote to carry, a quorum of 75% is required by default. | ||
|
||
If a TSC member wants to call for a vote that they wish to be non-public, they must do so by contacting the TSC Chairs directly. | ||
At the discretion of the TSC Chairs, a vote may be made non-public, and will then be handled by creating a Discussion in the orgs TSC Team page (?-- Or should this be an Issue in a private repo? That might be preferable as they can then be closed--). The topic and nature of non-public votes may remain non-public, including the results.(It is expected that vast majority of votes will be public. Non-public voting should only be used in exceptional circumstances.) | ||
|
||
#### Documenting decisions | ||
|
||
Either initially, or at any point during the process, any TSC member may suggest the issue being discussed is "significant or noteworthy." If there are no objections, the resolution actions for the issue must include the creation of an Any Decision Record (Previously named Architectural Decision Record). The Any Decision Record (ADR) should include as much information as is thought to be useful, following the provided template. The Pull Request for the ADR must be approved by all those who were involved in the decision making process, which must also be documented in the ADR as the "deciders." | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
(The quick consensus process does not require a Decision Record, but the decision should be minuted.) | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Non-public decisions should be documented (as an ADR or otherwise) in the private `private-tsc` repo. | ||
|
||
### Section 4.3: Other Project Roles (optional) | ||
|
||
The JSON Schema project recognises the need for both technical and non-technical roles. While the OpenJS Foundation takes on business responsibilities as the legal entity hosting the project, there are other non-technical responsibilities. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The TSC will look to create other roles as appropriate, and may update this document in accordance with the requirements for doing so, to formally recognise the additional roles. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The following responsibilities are recognised as those requiring roles to be defined by the TSC: | ||
- Community and Industry connections | ||
- Brand awareness, recognition, and health | ||
- Strategic allocation of funds and budgeting for investment in JSON Schema and its ecosystem | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Education and training | ||
- Financial allocation approval, tracking, and auditing | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Section 5: Definitions (optional) | ||
<!-- https://github.com/json-schema-org/community/discussions/286#discussioncomment-4391301 --> | ||
|
||
The JSON Schema project: The project which is housed by the OpenJS Foundation which operates as The JSON Schema Org. | ||
|
||
The JSON Schema Org: The people, policies, processes, activities, and artifacts, found within the GitHub json-schema-org. | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
TSC: The Technical Steering Committee, delegated technical leadership for the JSON Schema project by the OpenJS Foundation. | ||
|
||
--- | ||
|
||
This work is a derivative of the [WebdriverIO Project Governance Model](https://github.com/webdriverio/webdriverio/blob/main/GOVERNANCE.md). | ||
|
||
Inspired by https://seedsforchange.org.uk/consensus, https://seedsforchange.org.uk/quickconsensus | ||
Informed by https://www.ic.org/busting-the-myth-that-consensus-with-unanimity-is-good-for-communities/ | ||
|
||
This work is licensed under a [Creative Commons Attribution-ShareAlike 2.0 UK: England & Wales License](https://creativecommons.org/licenses/by-sa/2.0/uk/). | ||
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
Relequestual marked this conversation as resolved.
Show resolved
Hide resolved
|
Uh oh!
There was an error while loading. Please reload this page.