|
2 | 2 |
|
3 | 3 | ## Contributing to JSON Schema Specification
|
4 | 4 |
|
5 |
| -Thanks for taking the time to contribute! 🎉👍 |
| 5 | +Thanks for taking the time to contribute! 🎉👍 |
6 | 6 |
|
7 |
| -JSON Schema is an evolving language. This repository contains the specification text as well as Pull Requests with suggested improvements and contributions. |
| 7 | +JSON Schema is an evolving language. This repository contains the specification |
| 8 | +text as well as Pull Requests with suggested improvements and contributions. |
8 | 9 |
|
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 | +Contributions that do not change the interpretation of the spec but instead |
| 11 | +improve legibility, fix editorial errors, clear up ambiguity and improve |
| 12 | +examples are encouraged and are often merged by a spec editor with little |
| 13 | +process. |
10 | 14 |
|
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⚠️. |
| 15 | +However, contributions that *do* meaningfully change the interpretation of the |
| 16 | +spec must follow the [Specification Development Process](./PROCESS.md). |
12 | 17 |
|
13 | 18 | ## Issues
|
14 | 19 |
|
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). |
| 20 | +Issues should identify a problem, enhancement, or use case; and propose some |
| 21 | +course of action for the draft. For alternate support channels, see the |
| 22 | +[SUPPORT.md](https://github.com/json-schema-org/.github/blob/main/SUPPORT.md). |
16 | 23 |
|
17 | 24 | ## Pull Requests
|
18 | 25 |
|
19 |
| -We welcome pull requests, both for editorial suggestions and to resolve open issues. |
| 26 | +We welcome pull requests, both for editorial suggestions and to resolve open |
| 27 | +issues. |
20 | 28 |
|
21 |
| -If the pull request would solve a particular issue, reference the issue in the pull request description. |
| 29 | +If the pull request would solve a particular issue, reference the issue in the |
| 30 | +pull request description. |
22 | 31 |
|
23 |
| -Changes that would affect implementation behavior should typically be opened as an issue first. |
| 32 | +Changes that would affect implementation behavior should typically be opened as |
| 33 | +an issue first. |
24 | 34 |
|
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. |
| 35 | +Generally, pull requests should be made to the `main` branch unless it is a |
| 36 | +patch update and we are in a patch phase. In that case there will be a branch |
| 37 | +named something like `2020-12-patch` that the PR should target instead. |
26 | 38 |
|
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. |
| 39 | +Most PRs, including all PRs that impact implementation behavior, will be left |
| 40 | +open for a minimum of 14 days. Minor wording fixes may be merged more quickly |
| 41 | +once approved by a project member. |
28 | 42 |
|
29 | 43 | ## Milestones
|
30 | 44 |
|
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. |
| 45 | +Each milestone is an estimation of the work that will be done for the next |
| 46 | +draft. Milestones are typically named after the meta-schema draft number, and |
| 47 | +the *open* milestone with the lowest draft number is the current active project. |
32 | 48 |
|
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. |
| 49 | +Issues may be removed from a milestoned due to lack of consensus, lack of anyone |
| 50 | +with the correct expertise to make a PR, or simply because we wish to publish a |
| 51 | +draft and defer the remaining issues to the next draft. |
34 | 52 |
|
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. |
| 53 | +Numbered milestones other than the lowest-numbered one are used to tentatively |
| 54 | +organize future work, but may be completely reorganized once work on that draft |
| 55 | +actually begins. |
36 | 56 |
|
37 |
| -The `draft-future` milestone is for issues for which there is an agreement that they should be addressed, but no specific timeline. |
| 57 | +The `draft-future` milestone is for issues for which there is an agreement that |
| 58 | +they should be addressed, but no specific timeline. |
38 | 59 |
|
39 | 60 | ## Code of Conduct
|
40 | 61 |
|
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). |
| 62 | +All official channels including the mailing list, GitHub organization and Slack |
| 63 | +server, follow our |
| 64 | +[Code of Conduct](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md). |
42 | 65 |
|
43 | 66 | ## Have Questions?
|
44 | 67 |
|
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. |
| 68 | +You can join the `#specification` channel in our |
| 69 | +[Slack workspace](https://json-schema.org/slack) to interact with other |
| 70 | +community members involved in the Specification development, share new ideas and |
| 71 | +ask questions. |
46 | 72 |
|
0 commit comments