From c0382ecdf9603ba3d695b3853d7f219fafed3315 Mon Sep 17 00:00:00 2001 From: Benjamin Granados <40007659+benjagm@users.noreply.github.com> Date: Tue, 20 Jun 2023 15:28:20 +0200 Subject: [PATCH 1/5] Update CONTRIBUTING.md to remove outdated information Summary: This file is a brand new version of the contributing file to remove outdate information. Related issue: https://github.com/json-schema-org/json-schema-spec/issues/1414 --- CONTRIBUTING.md | 77 ++++++++++++------------------------------------- 1 file changed, 19 insertions(+), 58 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71cc8e8b..c58c5a7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,20 +1,20 @@ # Guidelines for contributing to the JSON Schema project -## Issues +## Contributing to JSON Schema Specification -Issues should identify an problem, enhancement, or use case; and propose some course of action for the draft. For alternate support channels, [see the json-schema.org website](http://json-schema.org/) or the [jsonschema tag on stackoverflow](https://stackoverflow.com/tags/jsonschema). +Thanks for taking the time to contribute!Ā šŸŽ‰šŸ‘ -## Milestones +JSON Schema is an evolving language. This repository contains the specification text as well as Pull Requests with suggested improvements and contributions. -Each milestone is an estimation of the work that will be done for the next draft. Milestones are typically named after the meta-schema draft number, and the *open* milestone with the lowest draft number is the current active project. +Contributions that do not change the interpretation of the spec but instead improve legibility, fix editorial errors, clear up ambiguity and improve examples are encouraged and are often merged by a spec editor with little process. -Issues may be removed from a milestoned due to lack of consensus, lack of anyone with the correct expertise to make a PR, or simply because we wish to publish a draft and defer the remaining issues to the next draft. +However, contributions thatĀ _do_Ā meaningfully change the interpretation of the spec must follow the Specification Development Process which is āš ļøalready under discussion and developmentāš ļø. -Numbered milestones other than the lowest-numbered one are used to tentatively organize future work, but may be completely reorganized once work on that draft actually begins. +## Issues -The `draft-future` milestone is for issues for which there is an agreement that they should be addressed, but no specific timeline. +Issues should identify an problem, enhancement, or use case; and propose some course of action for the draft. For alternate support channels,Ā see the [json-schema.org website](http://json-schema.org/)Ā or join ourĀ [Slack workspace](https://json-schema.org/slack)**. -## Pull requests +## Pull Requests We welcome pull requests, both for editorial suggestions and to resolve open issues. @@ -22,64 +22,25 @@ If the pull request would solve a particular issue, reference the issue in the p Changes that would affect implementation behavior should typically be opened as an issue first. -Generally, pull requests should be made to the `main` branch unless it is a -patch update and we are in a patch phase of the -[release process](https://github.com/json-schema-org/community/discussions/7). -In that case there will be a branch named something like `2020-12-patch` that -the PR should target instead. - -Most PRs, including all PRs that impact implementation behavior, will be left open for a minimum of 14 days. Minor wording fixes may be merged more quickly once approved by a project member. - -## Internet-Drafts and meta-schemas - -An Internet-Draft (I-D) publication replaces previous documents in their entirety. - -I-D updates that are purely editorial bug fixes (with no implementation-impacting changes) will continue to use the same meta-schemas as the version that they fix. - -I-D updates that impact behavior, whether as a bug fix or a new, changed, or removed feature, will have new meta-schemas published along with them. +Generally, pull requests should be made to theĀ `main`Ā branch unless it is a patch update and we are in a patch phase. In that case there will be a branch named something likeĀ `2020-12-patch`Ā that the PR should target instead. -The meta-schema URI is used to differentiate between different vocabularies (currently only Validation and Hyper-Schema). +Most PRs, including all PRs that impact implementation behavior, will be left open for a minimum of 14 days. Minor wording fixes may be merged more quickly once approved by a project member. -The authority on JSON Schema behavior is the respective specification document, not the JSON meta-schema; the JSON version of the meta-schema is maintained in an informative capacity only. - -As an informative document, bugs in the meta-schema may be fixed in place to align them with the normative specification. Examples of in-place fixes include adding an accidentally omitted keyword or fixing an incorrect type. By definition, no correct schema should fail validation against the meta-schema after a bug fix, although previously validating incorrect schemas may start to (correctly) fail validation. - -## Conduct - -All official channels including the mailing list, GitHub organization, Slack server, and IRC channels, follow our [Code of Conduct](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md). - - -## Financial contributions - -We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/json-schema). -Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed. - -## Credits +## Milestones -### Code Contributors +Each milestone is an estimation of the work that will be done for the next draft. Milestones are typically named after the meta-schema draft number, and theĀ _open_Ā milestone with the lowest draft number is the current active project. -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. - +Issues may be removed from a milestoned due to lack of consensus, lack of anyone with the correct expertise to make a PR, or simply because we wish to publish a draft and defer the remaining issues to the next draft. -### Financial Contributors +Numbered milestones other than the lowest-numbered one are used to tentatively organize future work, but may be completely reorganized once work on that draft actually begins. -Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/json-schema/contribute)] +TheĀ `draft-future`Ā milestone is for issues for which there is an agreement that they should be addressed, but no specific timeline. -#### Individuals +## Code of Conduct - +All official channels including the mailing list, GitHub organization, Slack server, and IRC channels, follow ourĀ [Code of Conduct](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md). -#### Organizations +## Have Questions? -Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/json-schema/contribute)] +You can join the `#specification` channel in ourĀ [Slack workspace](https://json-schema.org/slack)** to interact with other community members involved in the Specification development, share new ideas and ask questions. - - - - - - - - - - From ee701f2f6bcb165b9e07429073f4916c94a3272a Mon Sep 17 00:00:00 2001 From: Benjamin Granados <40007659+benjagm@users.noreply.github.com> Date: Fri, 15 Sep 2023 11:09:28 +0200 Subject: [PATCH 2/5] Update CONTRIBUTING.md Co-authored-by: Ben Hutton --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c58c5a7d..e68f6ab7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ JSON Schema is an evolving language. This repository contains the specification Contributions that do not change the interpretation of the spec but instead improve legibility, fix editorial errors, clear up ambiguity and improve examples are encouraged and are often merged by a spec editor with little process. -However, contributions thatĀ _do_Ā meaningfully change the interpretation of the spec must follow the Specification Development Process which is āš ļøalready under discussion and developmentāš ļø. +However, contributions thatĀ _do_Ā meaningfully change the interpretation of the spec must follow the Specification Development Process which is āš ļøcurrently under discussion and developmentāš ļø. ## Issues From 64fccb2ffad8566047a59eafa919f8cf4842682c Mon Sep 17 00:00:00 2001 From: Benjamin Granados <40007659+benjagm@users.noreply.github.com> Date: Fri, 15 Sep 2023 11:09:52 +0200 Subject: [PATCH 3/5] Update CONTRIBUTING.md Co-authored-by: Ben Hutton --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e68f6ab7..91eeb8d3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ However, contributions thatĀ _do_Ā meaningfully change the interpretation of the ## Issues -Issues should identify an problem, enhancement, or use case; and propose some course of action for the draft. For alternate support channels,Ā see the [json-schema.org website](http://json-schema.org/)Ā or join ourĀ [Slack workspace](https://json-schema.org/slack)**. +Issues should identify a problem, enhancement, or use case; and propose some course of action for the draft. For alternate support channels,Ā see the [json-schema.org website](http://json-schema.org/)Ā or join ourĀ [Slack workspace](https://json-schema.org/slack)**. ## Pull Requests From 625fc146cf9ce4d6cc6ff4c594544e897c6b636a Mon Sep 17 00:00:00 2001 From: Benjamin Granados <40007659+benjagm@users.noreply.github.com> Date: Fri, 15 Sep 2023 11:12:05 +0200 Subject: [PATCH 4/5] Update CONTRIBUTING.md Co-authored-by: Ben Hutton --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 91eeb8d3..bc326e57 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,5 +42,5 @@ All official channels including the mailing list, GitHub organization, Slack ser ## Have Questions? -You can join the `#specification` channel in ourĀ [Slack workspace](https://json-schema.org/slack)** to interact with other community members involved in the Specification development, share new ideas and ask questions. +You can join the `#specification` channel in ourĀ [Slack workspace](https://json-schema.org/slack) to interact with other community members involved in the Specification development, share new ideas and ask questions. From debcc2d1b44d2f862e481b7ca3b9fedf7a99c315 Mon Sep 17 00:00:00 2001 From: Benjamin Granados Date: Fri, 15 Sep 2023 11:14:18 +0200 Subject: [PATCH 5/5] Adding suggestion made in the PR. Adding suggestion made in the PR. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc326e57..a196f61e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ However, contributions thatĀ _do_Ā meaningfully change the interpretation of the ## Issues -Issues should identify a problem, enhancement, or use case; and propose some course of action for the draft. For alternate support channels,Ā see the [json-schema.org website](http://json-schema.org/)Ā or join ourĀ [Slack workspace](https://json-schema.org/slack)**. +Issues should identify a problem, enhancement, or use case; and propose some course of action for the draft. For alternate support channels, see the [SUPPORT.md](https://github.com/json-schema-org/.github/blob/main/SUPPORT.md). ## Pull Requests @@ -38,7 +38,7 @@ TheĀ `draft-future`Ā milestone is for issues for which there is an agreement tha ## Code of Conduct -All official channels including the mailing list, GitHub organization, Slack server, and IRC channels, follow ourĀ [Code of Conduct](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md). +All official channels including the mailing list, GitHub organization and Slack server, follow ourĀ [Code of Conduct](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md). ## Have Questions?