|
1 | 1 | # Guidelines for contributing to the JSON Schema project |
2 | 2 |
|
3 | | -## Issues |
| 3 | +## Contributing to JSON Schema Specification |
4 | 4 |
|
5 | | -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). |
| 5 | +Thanks for taking the time to contribute! 🎉👍 |
6 | 6 |
|
7 | | -## Milestones |
| 7 | +JSON Schema is an evolving language. This repository contains the specification text as well as Pull Requests with suggested improvements and contributions. |
8 | 8 |
|
9 | | -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. |
| 9 | +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. |
10 | 10 |
|
11 | | -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. |
| 11 | +However, contributions that _do_ meaningfully change the interpretation of the spec must follow the Specification Development Process which is ⚠️currently under discussion and development⚠️. |
12 | 12 |
|
13 | | -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. |
| 13 | +## Issues |
14 | 14 |
|
15 | | -The `draft-future` milestone is for issues for which there is an agreement that they should be addressed, but no specific timeline. |
| 15 | +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). |
16 | 16 |
|
17 | | -## Pull requests |
| 17 | +## Pull Requests |
18 | 18 |
|
19 | 19 | We welcome pull requests, both for editorial suggestions and to resolve open issues. |
20 | 20 |
|
21 | 21 | If the pull request would solve a particular issue, reference the issue in the pull request description. |
22 | 22 |
|
23 | 23 | Changes that would affect implementation behavior should typically be opened as an issue first. |
24 | 24 |
|
25 | | -Generally, pull requests should be made to the `main` branch unless it is a |
26 | | -patch update and we are in a patch phase of the |
27 | | -[release process](https://github.com/json-schema-org/community/discussions/7). |
28 | | -In that case there will be a branch named something like `2020-12-patch` that |
29 | | -the PR should target instead. |
30 | | - |
31 | | -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. |
32 | | - |
33 | | -## Internet-Drafts and meta-schemas |
34 | | - |
35 | | -An Internet-Draft (I-D) publication replaces previous documents in their entirety. |
36 | | - |
37 | | -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. |
38 | | - |
39 | | -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. |
| 25 | +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. |
40 | 26 |
|
41 | | -The meta-schema URI is used to differentiate between different vocabularies (currently only Validation and Hyper-Schema). |
| 27 | +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. |
42 | 28 |
|
43 | | -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. |
44 | | - |
45 | | -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. |
46 | | - |
47 | | -## Conduct |
48 | | - |
49 | | -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). |
50 | | - |
51 | | - |
52 | | -## Financial contributions |
53 | | - |
54 | | -We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/json-schema). |
55 | | -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. |
56 | | - |
57 | | -## Credits |
| 29 | +## Milestones |
58 | 30 |
|
59 | | -### Code Contributors |
| 31 | +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. |
60 | 32 |
|
61 | | -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. |
62 | | -<a href="https://github.com/json-schema-org/json-schema-spec/graphs/contributors"><img src="https://opencollective.com/json-schema/contributors.svg?width=890&button=false" /></a> |
| 33 | +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. |
63 | 34 |
|
64 | | -### Financial Contributors |
| 35 | +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. |
65 | 36 |
|
66 | | -Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/json-schema/contribute)] |
| 37 | +The `draft-future` milestone is for issues for which there is an agreement that they should be addressed, but no specific timeline. |
67 | 38 |
|
68 | | -#### Individuals |
| 39 | +## Code of Conduct |
69 | 40 |
|
70 | | -<a href="https://opencollective.com/json-schema"><img src="https://opencollective.com/json-schema/individuals.svg?width=890"></a> |
| 41 | +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). |
71 | 42 |
|
72 | | -#### Organizations |
| 43 | +## Have Questions? |
73 | 44 |
|
74 | | -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)] |
| 45 | +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. |
75 | 46 |
|
76 | | -<a href="https://opencollective.com/json-schema/organization/0/website"><img src="https://opencollective.com/json-schema/organization/0/avatar.svg"></a> |
77 | | -<a href="https://opencollective.com/json-schema/organization/1/website"><img src="https://opencollective.com/json-schema/organization/1/avatar.svg"></a> |
78 | | -<a href="https://opencollective.com/json-schema/organization/2/website"><img src="https://opencollective.com/json-schema/organization/2/avatar.svg"></a> |
79 | | -<a href="https://opencollective.com/json-schema/organization/3/website"><img src="https://opencollective.com/json-schema/organization/3/avatar.svg"></a> |
80 | | -<a href="https://opencollective.com/json-schema/organization/4/website"><img src="https://opencollective.com/json-schema/organization/4/avatar.svg"></a> |
81 | | -<a href="https://opencollective.com/json-schema/organization/5/website"><img src="https://opencollective.com/json-schema/organization/5/avatar.svg"></a> |
82 | | -<a href="https://opencollective.com/json-schema/organization/6/website"><img src="https://opencollective.com/json-schema/organization/6/avatar.svg"></a> |
83 | | -<a href="https://opencollective.com/json-schema/organization/7/website"><img src="https://opencollective.com/json-schema/organization/7/avatar.svg"></a> |
84 | | -<a href="https://opencollective.com/json-schema/organization/8/website"><img src="https://opencollective.com/json-schema/organization/8/avatar.svg"></a> |
85 | | -<a href="https://opencollective.com/json-schema/organization/9/website"><img src="https://opencollective.com/json-schema/organization/9/avatar.svg"></a> |
0 commit comments