Skip to content

Commit 17ab8d6

Browse files
committed
Update CONTRIBUTING.md
1 parent 8a686f6 commit 17ab8d6

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,11 @@ Plus some suggestions, rather than rules:
214214
* property of a "plain" JSON object that is not an OpenAPI-defined Foo Object -> "property"
215215
* "attribute" is only used in the XML context and means "XML attribute"
216216

217+
### Field Names and Values in YAML comments
218+
219+
Field names and entries such as content types should be in backticks, they would be fixed-width fonts if the markdown was rendered (which the comments are not).
220+
Values like "Dog" should be double quoted as they are a value rather than a keyword.
221+
217222
## Release Process and Scope
218223

219224
This section relates to the 3.x versions only.

0 commit comments

Comments
 (0)