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
+23-1
Original file line number
Diff line number
Diff line change
@@ -35,6 +35,28 @@ Schemas are only changed _after_ the specification is changed. Changes are made
35
35
36
36
* Issue #3576: [What is our authoritative spec URL and how do people find it?](https://github.com/OAI/OpenAPI-Specification/issues/3576)
37
37
38
+
## Style Guide
39
+
40
+
Contributions to this repository should follow the style guide as described in this section.
41
+
42
+
### Markdown
43
+
44
+
Markdown files in this project should follow the style enforced by the [markdownlint tool][],
45
+
as configured by the `.markdownlint.json` file in the root of the project.
46
+
47
+
The following additional rules should be followed but currently are not enforced by tooling:
48
+
49
+
1. The first mention of a normative reference or an OAS-defined Object in a (sub)*section is a link, additional mentions are not
50
+
2. OAS-defined Foo Bar Objects are written in this style, and are not monospaced
51
+
3. "example" instead of "sample" - this spec is not about statistics
52
+
4. Use "OpenAPI Object" instead of "root"
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.
57
+
9. "attribute" is only used in the XML context and means "XML attribute"
@@ -95,7 +117,7 @@ The OpenAPI Initiative uses GitHub Projects to manage work _outside_ of the spec
95
117
96
118
### Discussions
97
119
98
-
We are beginning (as of mid-2024) to use GitHub [discussions](https://github.com/OAI/OpenAPI-Specification/discussions?discussions_q=is%3Aopen) for open-ended topics such as major enhancements.
120
+
We are beginning (as of mid-2024) to use GitHub [discussions](https://github.com/OAI/OpenAPI-Specification/discussions?discussions_q=is%3Aopen) for open-ended topics such as major enhancements.
99
121
100
122
* Issue #3518: [Define criteria for filing/closing issues vs discussions](https://github.com/OAI/OpenAPI-Specification/issues/3518)
0 commit comments