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
+4-4
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Exceptions may be made when links to external URLs have been changed by a 3rd pa
10
10
11
11
Published versions of the specification are in the `versions/` folder.
12
12
The under-development versions of the specification are in the file `spec/oas.md` on the appropriately-versioned branch.
13
-
For example, work on the next patch release for 3.2 is on `v3.2-dev` in the file `spec/oas.md`.
13
+
For example, work on the next release for 3.2 is on `v3.2-dev` in the file `spec/oas.md`.
14
14
15
15
The [spec site](https://spec.openapis.org) is the source of truth for the OpenAPI specification as it contains all the citations and author credits (the markdown in this repository was previously the authoritative version until 2024).
16
16
@@ -118,7 +118,7 @@ Labels related to [issue automation](#appendix-issue-automation)
118
118
### Milestones
119
119
120
120
We use milestones in GitHub to plan what should be included in future releases.
121
-
Issues and pull requests should both be added to the milestone we expect they will be released in.
121
+
Issues and pull requests should both be added to the earliest milestone we expect they will be released in.
122
122
Any changes that aren't ready in time for release should be moved to the next milestone or untagged.
123
123
124
124
The milestones and items assigned to them are under constant review and subject to change.
@@ -291,7 +291,7 @@ To get in touch with other people on the project, ask questions, or anything els
291
291
- Start a [GitHub Discussion](https://github.com/OAI/OpenAPI-Specification/discussions/).
292
292
- Join one of our weekly meetings by checking the [issues list for an upcoming meetings](https://github.com/OAI/OpenAPI-Specification/issues?q=is%3Aissue%20state%3Aopen%20label%3AHousekeeping).
293
293
294
-
###Appendix: Branch strategy
294
+
## Appendix: Branch strategy
295
295
296
296
For information on the branch and release strategy for OAS 3.0.4 and 3.1.1 and earlier, see the comments in [issue #3677](https://github.com/OAI/OpenAPI-Specification/issues/3677).
297
297
@@ -307,7 +307,7 @@ For information on the branch and release strategy for OAS 3.0.4 and 3.1.1 and e
307
307
Upon release:
308
308
309
309
* Pre-release steps:
310
-
* The most recent _published_ patch release from the previoius line is merged up to `vX.Y-dev`, if relevant
310
+
* The most recent _published_ patch release from the previous line is merged up to `vX.Y-dev`, if relevant
311
311
* If doing simultaneous releases on multiple lines, do them from the oldest to newest line
312
312
* If the release is the most recent on the current line, merge `vX.Y-dev` to `dev`
Copy file name to clipboardExpand all lines: style-guide.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ The following additional rules should be followed but currently are not enforced
18
18
6. Field values are monospaced in JSON notation: `true`, `false`, `null`, `"header"` (with double-quotes around string values).
19
19
7. A combination of fixed field name with example value uses JS notation: `in: "header"`, combining rules 5 and 6.
20
20
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.
21
-
9. Use Oxford commas, avoid Shatner commas.
21
+
9. Use [Oxford commas](https://en.wikipedia.org/wiki/Serial_comma), avoid [Shatner commas](https://www.latimes.com/archives/blogs/jacket-copy/story/2011-06-30/goodbye-oxford-comma-hello-shatner-comma).
22
22
10. Use `<span id="thing"></span>` for link anchors. The `<a name="thing"></a>` format has been deprecated.
23
23
11. Headings use [title case](https://en.wikipedia.org/wiki/Title_case) and are followed by a blank line.
0 commit comments