You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
-16Lines changed: 0 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,30 +98,14 @@ The goal of JSON Schemas in this repository is to correctly validate schemas tha
98
98
### Useful Conventions
99
99
100
100
- Consider using documentation URLs in `"description"` to improve UX. Most schemas use the format `<description>\n<url>`. For example: `"Whether to ignore a theme configuration for the current site\nhttps://jekyllrb.com/docs/configuration/options/#global-configuration"`
101
-
- Consider using the [`base.json`][base] schema for `draft-07` or [`base-04.json`][base-04] for `draft-04` to use subschemas that are commonly used.
102
101
- When writing `description`, avoid phrases like "there are three possibilities" and "valid values are" in favor of adding the constraints to the schema directly.
103
102
- If you choose to use `title`, we recommend formatting it so that object values look like types in programming languages. This includes:
104
103
- Omitting leading articles and trailing punctuation
105
104
- Beginning it with a lowercase letter
106
105
- Using nouns instead of sentences
107
106
108
-
**Unofficial Strict Mode**
109
-
110
-
> [!WARNING]
111
-
> This "unofficial strict mode" may have bugs or be incomplete.
112
-
113
-
There is an [unofficial draft-07][draft-07-unofficial-strict] schema that uses JSON Schema to validate your JSON Schema. It checks that:
114
-
115
-
-`type`, `title`, `description` properties are required
116
-
- There are no empty arrays. For instance, it's impossible to write less than 2 sub-schemas for `allOf`
117
-
-`type` can't be an array, which is intentional, `anyOf`/`oneOf` should be used in this case
118
-
- It links to [understanding-json-schema](https://json-schema.org/understanding-json-schema) for each hint/check
119
-
120
-
To check your schema against that schema, use `node cli.js check-strict --schema-name=<schemaName.json>`. Note that this is NOT the same as Ajv strict mode.
0 commit comments