Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit b57419f

Browse files
Additional lint cleanup
1 parent 9f29cff commit b57419f

13 files changed

+371
-272
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Thanks for submitting a pull request! Please provide enough information so that
1515
### Issue & Discussion References
1616

1717
<!-- Pick at least one of the below options, and remove those which don't apply. -->
18-
- Closes #___ <!-- Replace ___ with the issue number this PR resolves -->
19-
- Related to #___ <!-- Use when the PR doesn't completely resolve an issue -->
20-
- Others? <!-- Add any additional notes or references here -->
18+
- Closes #___ <!-- Replace ___ with the issue number this PR resolves -->
19+
- Related to #___ <!-- Use when the PR doesn't completely resolve an issue -->
20+
- Others? <!-- Add any additional notes or references here -->
2121

2222
### Summary
2323

‎.github/SECURITY.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11
# Reporting Security Issues
22

3-
The JSON Schema project does not house any implementation of JSON Schema itself. If you have found a security issue in any implementation of JSON Schema, please contact the appropriate maintainers, per the projects security reporting guidelines, if any.
3+
The JSON Schema project does not house any implementation of JSON Schema itself.
4+
If you have found a security issue in any implementation of JSON Schema, please
5+
contact the appropriate maintainers, per the projects security reporting
6+
guidelines, if any.
47

5-
To report a security issue, please use the GitHub Security Advisory "https://github.com/json-schema-org/json-schema-spec/security/advisories/new" tab.
8+
To report a security issue, please use the GitHub Security Advisory
9+
"<https://github.com/json-schema-org/json-schema-spec/security/advisories/new>"
10+
tab.
611

7-
If you find a security issue in relation to the JSON Schema specification or another repository within this GitHub organization, please use the above.
12+
If you find a security issue in relation to the JSON Schema specification or
13+
another repository within this GitHub organization, please use the above.
814

9-
The JSON Schema project TSC will review and respond to all security reports. Please follow [coordinated disclosure](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities).
15+
The JSON Schema project TSC will review and respond to all security reports.
16+
Please follow [coordinated disclosure](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities).
17+
18+
If you are a maintainer of an implementation, please consider [adding a security
19+
policy](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository).
20+
If you need assistance in understanding a report, or remediation of a confirmed
21+
issue, please feel free to reach out to us on our Slack server, in the
22+
`#implementations` channel, and ask for a temporary private channel to discuss
23+
your situation or concerns.
1024

11-
If you are a maintainer of an implementation, please consider [adding a security policy](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository). If you need assistance in understanding a report, or remediation of a confirmed issue, please feel free to reach out to us on our Slack server, in the `#implementations` channel, and ask for a temporary private channel to discuss your situation or concerns.

‎.remarkrc-lint.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import remarkPresetLintMarkdownStyleGuide from "remark-preset-lint-markdown-styl
55
import remarkLintListItemIndent from "remark-lint-list-item-indent";
66
import remarkLintListItemSpacing from "remark-lint-list-item-spacing";
77
import remarkLintNoFileNameMixedCase from "remark-lint-no-file-name-mixed-case";
8+
import remarkLintNoFileNameIrregularCharacters from "remark-lint-no-file-name-irregular-characters";
89

910

1011
export default {
@@ -15,6 +16,7 @@ export default {
1516
remarkPresetLintMarkdownStyleGuide,
1617
[remarkLintListItemIndent, "one"],
1718
[remarkLintListItemSpacing, { checkBlanks: true }],
18-
[remarkLintNoFileNameMixedCase, false]
19+
[remarkLintNoFileNameMixedCase, false],
20+
[remarkLintNoFileNameIrregularCharacters, false]
1921
]
2022
};

‎PROCESS.md

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1+
<!--lint ignore maximum-heading-length-->
12
# JSON Schema Specification Development and Publication Process
23

34
## Purpose
45

56
This document describes the development and publication process for the JSON
67
Schema specifications contained within this repository.
78

8-
- [JSON Schema Core](./jsonschema-core.md)
9-
- [JSON Schema Validation](./jsonschema-validation.md)
9+
- [JSON Schema Core](./specs/jsonschema-core.md)
10+
- [JSON Schema Validation](./specs/jsonschema-validation.md)
1011

1112
## Definitions
1213

@@ -43,18 +44,20 @@ and instance across two consecutive releases to illustrate the compatibility of
4344
those releases:
4445

4546
| *Next* ➡️<br>⬇️ *Current* | pass | fail | indeterminate |
46-
|:-----------------------:|:----:|:----:|:-------------:|
47+
|:-----------------------:|:--: |:--: |:-----------: |
4748
| **pass** | ✅ | ❌ | ❌ |
4849
| **fail** | ❌ | ✅ | ❌ |
4950
| **indeterminate** | ✅ | ✅ | ✅ |
5051

5152
### Release
5253

53-
A release is any single publication of the JSON Schema specifications (as a group).
54+
A release is any single publication of the JSON Schema specifications (as a
55+
group).
5456

5557
### Version
5658

57-
Consecutive releases which maintain compatibility with each other comprise a version.
59+
Consecutive releases which maintain compatibility with each other comprise a
60+
version.
5861

5962
## Release and Version
6063

@@ -78,10 +81,8 @@ The specifications will be published on the JSON Schema website,
7881
<https://json-schema.org/>, using a path comprised of the version, year, and
7982
document name. For example,
8083

81-
```
82-
https://json-schema.org/1/2025/core.html
83-
https://json-schema.org/1/2025/validation.html
84-
```
84+
- `https://json-schema.org/1/2025/core.html`
85+
- `https://json-schema.org/1/2025/validation.html`
8586

8687
Once a specification document has been published, neither the document (save for
8788
minor errata such as spelling mistakes) nor its publication URL may change. If
@@ -93,30 +94,22 @@ future publications and are not retroactive.
9394
A release meta-schema will be published under the same path using `schema.json`
9495
as the file name.
9596

96-
```
97-
https://json-schema.org/1/2025/schema.json
98-
```
97+
- `https://json-schema.org/1/2025/schema.json`
9998

10099
The website will also be configured to:
101100

102-
- serve the meta-schema from its release folder
103-
```
104-
https://json-schema.org/1/2025/
105-
```
101+
- serve the meta-schema from its release folder:
102+
`https://json-schema.org/1/2025/`
106103
- serve the meta-schema for the latest release in a version from its version
107-
folder
108-
```
109-
https://json-schema.org/1/
110-
```
104+
folder: `https://json-schema.org/1/`
111105

112106
The latest-release meta-schemas will be updated with proposals as indicated by
113107
the [Proposal section](#proposal) of this document.
114108

115-
> [!IMPORTANT]
109+
> \[!IMPORTANT]
116110
> These are only publication and availability URLs. The specification will
117111
> define the `$id` values for the meta-schemas.
118112
119-
120113
## Feature Life Cycle
121114

122115
New features will progress through a sequence of stages before being added to
@@ -168,14 +161,15 @@ stable features. Questions to address may include:
168161
At least two (2) Core Team members must have implemented prototypes before the
169162
concept can continue to the formal proposal process.
170163

171-
### Proposal {#proposal}
164+
### Proposal
172165

173166
Once a rough consensus for the idea has been reached, a formal proposal will be
174167
written, separate from the specification, with the goal of precisely defining
175168
specification changes.
176169

177-
The proposal will use the [Proposal Template](./proposals/proposal-template.md)
178-
and be stored in this repository's `proposals` folder.
170+
The proposal will use the [Proposal
171+
Template](./specs/proposals/proposal-template.md) and be stored in this
172+
repository's `proposals` folder.
179173

180174
Additionally, a draft ADR will be included using the file name of the proposal
181175
document with an `-adr` suffix: `{proposal-file-name}-adr.md`. This ADR will
@@ -191,7 +185,7 @@ indicating that the feature is experimental and containing a link to the
191185
proposal document. Aside from the `$comment` keyword, the subschema will be
192186
empty.
193187

194-
> [!NOTE]
188+
> \[!NOTE]
195189
> This is done so that a proposed keyword is allowed but not validated as its
196190
> syntax may change during the proposal/experimentation process. It also permits
197191
> different implementations to support different variations of each proposal
@@ -226,15 +220,16 @@ In order to proceed to the next stage ([Stable](#stable)):
226220
@@ TODO: Determine usage metrics. @@
227221
```
228222

229-
Experimental features are not considered to be interoperable across implementations.
223+
Experimental features are not considered to be interoperable across
224+
implementations.
230225

231226
If a proposal cannot advance to the next stage, it may be removed. The proposal
232227
document is moved to an `archive` subfolder, the keyword is removed from the
233228
meta-schemas, and any tests are moved to an `archive` subfolder. The removal of
234229
a feature which has not reached the stable state is not considered a breaking
235230
change.
236231

237-
### Stable {#stable}
232+
### Stable
238233

239234
The feature is incorporated into the specification in the `main` branch as
240235
specified by the proposal document, and the feature will be required as of the

‎README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Please read our [guidelines for contributing](CONTRIBUTING.md).
1818

1919
## Status
2020

21-
For the current status of issues and pull requests, please see the following labels
21+
For the current status of issues and pull requests, please see the following
22+
labels
2223

2324
[![Available](https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Status:%20Available.svg?color=brightgreen)](https://github.com/json-schema-org/json-schema-spec/issues?q=is%3Aopen+is%3Aissue+label%3A%22Status%3A+Available%22)
2425
[![In Progress](https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Status:%20In%20Progress.svg)](https://github.com/json-schema-org/json-schema-spec/labels/Status:%20In%20Progress)
@@ -74,12 +75,10 @@ features they make available to you.
7475
- [remark-reference-links](/json-schema-org/json-schema-spec/blob/main/build/remark-reference-links.js)
7576
-- Adds new syntax for referencing a section of the spec using the section
7677
number as the link text.
77-
- Example:
78+
- Example:
7879
```markdown
7980
## Foo {#foo}
80-
8181
## Bar
82-
8382
This is covered in {{foo}} // --> Renders to "This is covered in [Section 2.3](#foo)"
8483
- Link text will use "Section" or "Appendix" as needed
8584
```
@@ -104,12 +103,11 @@ features they make available to you.
104103
- [remark-flexible-containers](https://github.com/ipikuka/remark-flexible-containers)
105104
-- Add a callout box using the following syntax. Supported container types are
106105
`warning`, `note`, and `experimental`.
107-
108-
```
109-
::: {type} {title}
110-
{content}
111-
:::
112-
```
106+
```markdown
107+
::: {type} {title}
108+
{content}
109+
:::
110+
```
113111

114112
### Internet-Drafts
115113

@@ -148,19 +146,16 @@ The source for the website is [maintained in a separate repository](https://gith
148146

149147
### Code Contributors
150148

151-
This project exists thanks to all the people who contribute.
152-
[[Contribute](CONTRIBUTING.md)]. <a
153-
href="https://github.com/json-schema-org/json-schema-spec/graphs/contributors"><img
154-
src="https://opencollective.com/json-schema/contributors.svg?width=890&button=false"
155-
/></a>
149+
This project exists thanks to all the people who contribute. \[[Contribute](CONTRIBUTING.md)].
150+
<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>
156151

157152
### Financial Contributors
158153

159-
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/json-schema/contribute)]
154+
Become a financial contributor and help us sustain our community. \[[Contribute](https://opencollective.com/json-schema/contribute)]
160155

161156
#### Sponsors
162157

163-
Here are our top sponsors. You could be next! [[Become a sponsor](https://opencollective.com/json-schema#sponsor)]
158+
Here are our top sponsors. You could be next! \[[Become a sponsor](https://opencollective.com/json-schema#sponsor)]
164159

165160
<a href="https://opencollective.com/json-schema/sponsor/0/website" target="_blank"><img src="https://opencollective.com/json-schema/sponsor/0/avatar.svg"></a>
166161
<a href="https://opencollective.com/json-schema/sponsor/1/website" target="_blank"><img src="https://opencollective.com/json-schema/sponsor/1/avatar.svg"></a>

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /