Skip to content

Commit 77b6518

Browse files
committed
Update markdown files from pull request feedback
1 parent b9f244f commit 77b6518

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Exceptions may be made when links to external URLs have been changed by a 3rd pa
1010

1111
Published versions of the specification are in the `versions/` folder.
1212
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`.
1414

1515
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).
1616

@@ -118,7 +118,7 @@ Labels related to [issue automation](#appendix-issue-automation)
118118
### Milestones
119119

120120
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.
122122
Any changes that aren't ready in time for release should be moved to the next milestone or untagged.
123123

124124
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
291291
- Start a [GitHub Discussion](https://github.com/OAI/OpenAPI-Specification/discussions/).
292292
- 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).
293293

294-
### Appendix: Branch strategy
294+
## Appendix: Branch strategy
295295

296296
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).
297297

@@ -307,7 +307,7 @@ For information on the branch and release strategy for OAS 3.0.4 and 3.1.1 and e
307307
Upon release:
308308

309309
* 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
311311
* If doing simultaneous releases on multiple lines, do them from the oldest to newest line
312312
* If the release is the most recent on the current line, merge `vX.Y-dev` to `dev`
313313
* For example, if releasing 3.1.3 and 3.2.0:

style-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following additional rules should be followed but currently are not enforced
1818
6. Field values are monospaced in JSON notation: `true`, `false`, `null`, `"header"` (with double-quotes around string values).
1919
7. A combination of fixed field name with example value uses JS notation: `in: "header"`, combining rules 5 and 6.
2020
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).
2222
10. Use `<span id="thing"></span>` for link anchors. The `<a name="thing"></a>` format has been deprecated.
2323
11. Headings use [title case](https://en.wikipedia.org/wiki/Title_case) and are followed by a blank line.
2424

0 commit comments

Comments
 (0)