Skip to content

Commit 9af82de

Browse files
Apply suggestions from PR review
Co-authored-by: Ralf Handl <[email protected]>
1 parent aa7c172 commit 9af82de

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Contributions to this repository should follow the style guide as described in t
4141

4242
### Markdown
4343

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),
4545
as configured by the `.markdownlint.json` file in the root of the project.
4646

4747
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
5151
3. "example" instead of "sample" - this spec is not about statistics
5252
4. Use "OpenAPI Object" instead of "root"
5353
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.
5757
9. "attribute" is only used in the XML context and means "XML attribute"
5858
10. Use Oxford commas, avoid Shatner commas
5959

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"
66+
6067
## Release Process and Scope
6168

6269
* Issue #3528: [3.x.y patch release approach](https://github.com/OAI/OpenAPI-Specification/issues/3528)

0 commit comments

Comments
 (0)