Skip to content

Commit

Permalink
Additional lint cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
jdesrosiers committed Nov 13, 2024
1 parent 9f29cff commit 668be4b
Show file tree
Hide file tree
Showing 13 changed files with 375 additions and 276 deletions.
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Thanks for submitting a pull request! Please provide enough information so that
### Issue & Discussion References

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

### Summary

Expand Down
23 changes: 18 additions & 5 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,24 @@
# Reporting Security Issues

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.
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.

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

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

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).
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).

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.

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.
4 changes: 3 additions & 1 deletion .remarkrc-lint.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import remarkPresetLintMarkdownStyleGuide from "remark-preset-lint-markdown-styl
import remarkLintListItemIndent from "remark-lint-list-item-indent";
import remarkLintListItemSpacing from "remark-lint-list-item-spacing";
import remarkLintNoFileNameMixedCase from "remark-lint-no-file-name-mixed-case";
import remarkLintNoFileNameIrregularCharacters from "remark-lint-no-file-name-irregular-characters";


export default {
Expand All @@ -15,6 +16,7 @@ export default {
remarkPresetLintMarkdownStyleGuide,
[remarkLintListItemIndent, "one"],
[remarkLintListItemSpacing, { checkBlanks: true }],
[remarkLintNoFileNameMixedCase, false]
[remarkLintNoFileNameMixedCase, false],
[remarkLintNoFileNameIrregularCharacters, false]
]
};
51 changes: 23 additions & 28 deletions PROCESS.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
<!--lint ignore maximum-heading-length-->
# JSON Schema Specification Development and Publication Process

## Purpose

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

- [JSON Schema Core](./jsonschema-core.md)
- [JSON Schema Validation](./jsonschema-validation.md)
- [JSON Schema Core](./specs/jsonschema-core.md)
- [JSON Schema Validation](./specs/jsonschema-validation.md)

## Definitions

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

| *Next* ➡️<br>⬇️ *Current* | pass | fail | indeterminate |
|:-----------------------:|:----:|:----:|:-------------:|
| :-----------------------: | :--: | :--: | :-----------: |
| **pass** ||||
| **fail** ||||
| **indeterminate** ||||

### Release

A release is any single publication of the JSON Schema specifications (as a group).
A release is any single publication of the JSON Schema specifications (as a
group).

### Version

Consecutive releases which maintain compatibility with each other comprise a version.
Consecutive releases which maintain compatibility with each other comprise a
version.

## Release and Version

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

```
https://json-schema.org/1/2025/core.html
https://json-schema.org/1/2025/validation.html
```
- `https://json-schema.org/1/2025/core.html`
- `https://json-schema.org/1/2025/validation.html`

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

```
https://json-schema.org/1/2025/schema.json
```
- `https://json-schema.org/1/2025/schema.json`

The website will also be configured to:

- serve the meta-schema from its release folder
```
https://json-schema.org/1/2025/
```
- serve the meta-schema from its release folder:
`https://json-schema.org/1/2025/`
- serve the meta-schema for the latest release in a version from its version
folder
```
https://json-schema.org/1/
```
folder: `https://json-schema.org/1/`

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

> [!IMPORTANT]
> \[!IMPORTANT]
> These are only publication and availability URLs. The specification will
> define the `$id` values for the meta-schemas.

## Feature Life Cycle

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

### Proposal {#proposal}
### Proposal

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

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

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

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

Experimental features are not considered to be interoperable across implementations.
Experimental features are not considered to be interoperable across
implementations.

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

### Stable {#stable}
### Stable

The feature is incorporated into the specification in the `main` branch as
specified by the proposal document, and the feature will be required as of the
Expand Down
37 changes: 16 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Please read our [guidelines for contributing](CONTRIBUTING.md).

## Status

For the current status of issues and pull requests, please see the following labels
For the current status of issues and pull requests, please see the following
labels

[![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)
[![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)
Expand Down Expand Up @@ -62,7 +63,7 @@ features they make available to you.
- [remark-heading-id](https://github.com/imcuttle/remark-heading-id) -- Adds
support for `{#my-anchor}` syntax to add an `id` to an element so it can be
referenced using URI fragment syntax.
- [remark-headings](/json-schema-org/json-schema-spec/blob/main/build/remark-headings.js)
- [remark-headings](/json-schema-org/json-schema-spec/blob/main/remark/remark-headings.js)
-- A collection of enhancements for headings.
- Adds hierarchical section numbers to headings.
- Use the `%appendix%` prefix on headings that should be numbered as an
Expand All @@ -71,22 +72,20 @@ features they make available to you.
- Example: `#section-2-13`
- Example: `#appendix-a`
- Makes the heading a link utilizing its anchor
- [remark-reference-links](/json-schema-org/json-schema-spec/blob/main/build/remark-reference-links.js)
- [remark-reference-links](/json-schema-org/json-schema-spec/blob/main/remark/remark-reference-links.js)
-- Adds new syntax for referencing a section of the spec using the section
number as the link text.
- Example:
- Example:
```markdown
## Foo {#foo}

## Bar

This is covered in {{foo}} // --> Renders to "This is covered in [Section 2.3](#foo)"
- Link text will use "Section" or "Appendix" as needed
```
- [remark-table-of-contents](/json-schema-org/json-schema-spec/blob/main/build/remark-table-of-contents.js)
- [remark-table-of-contents](/json-schema-org/json-schema-spec/blob/main/remark/remark-table-of-contents.js)
-- Adds a table of contents in a section with a header called "Table of
Contents".
- [remark-code-titles](/json-schema-org/json-schema-spec/blob/main/build/remark-code-titles.js)
- [remark-code-titles](/json-schema-org/json-schema-spec/blob/main/remark/remark-code-titles.js)
-- Add titles to code blocks
- Example:
```markdown
Expand All @@ -104,12 +103,11 @@ features they make available to you.
- [remark-flexible-containers](https://github.com/ipikuka/remark-flexible-containers)
-- Add a callout box using the following syntax. Supported container types are
`warning`, `note`, and `experimental`.

```
::: {type} {title}
{content}
:::
```
```markdown
::: {type} {title}
{content}
:::
```

### Internet-Drafts

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

### Code Contributors

This project exists thanks to all the people who contribute.
[[Contribute](CONTRIBUTING.md)]. <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>
This project exists thanks to all the people who contribute. \[[Contribute](CONTRIBUTING.md)].
<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>

### Financial Contributors

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

#### Sponsors

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

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

0 comments on commit 668be4b

Please sign in to comment.