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
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ Contributions to this repository should follow the style guide as described in t
41
41
42
42
### Markdown
43
43
44
-
Markdown files in this project should follow the style enforced by the [markdownlint tool][],
44
+
Markdown files in this project should follow the style enforced by the [markdownlint tool](https://www.npmjs.com/package/markdownlint),
45
45
as configured by the `.markdownlint.json` file in the root of the project.
46
46
47
47
The following additional rules should be followed but currently are not enforced by tooling:
@@ -51,12 +51,19 @@ The following additional rules should be followed but currently are not enforced
51
51
3. "example" instead of "sample" - this spec is not about statistics
52
52
4. Use "OpenAPI Object" instead of "root"
53
53
5. Fixed fields are monospaced
54
-
6. Field values are monospaced in JSON notation: true, false, null, "header", ...
55
-
7. A combination of fixed field name with example value uses JS notation: in: "header", combining rules 5 and 6
56
-
8. An exception to 5-7 is colloquial use, for example "values of type array or object" - "type" is not monospaced, so the monospaced values aren't enclosed in double quotes.
54
+
6. Field values are monospaced in JSON notation: `true`, `false`, `null`, `"header"` (with double-quotes around string values), ...
55
+
7. A combination of fixed field name with example value uses JS notation: `in: "header"`, combining rules 5 and 6
56
+
8. An exception to 5-7 is colloquial use, for example "values of type `array` or `object`" - "type" is not monospaced, so the monospaced values aren't enclosed in double quotes.
57
57
9. "attribute" is only used in the XML context and means "XML attribute"
58
58
10. Use Oxford commas, avoid Shatner commas
59
59
60
+
### Use of "keyword", "field", "property", and "attribute"
61
+
62
+
* JSON Schema keywords -> "keyword"
63
+
* OpenAPI fixed fields -> "field"
64
+
* property of a "plain" JSON object that is not an OpenAPI-defined Foo Object -> "property"
65
+
* "attribute" is only used in the XML context and means "XML attribute"
0 commit comments