Skip to content

Commit 28c5df3

Browse files
lornajaneralfhandl
andauthored
Apply suggestions from code review
Co-authored-by: Ralf Handl <[email protected]>
1 parent 4a81dcb commit 28c5df3

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Most issues should have a clear outcome; something will be fixed, improved or ot
6868

6969
We use [discussions](#discussions) for ideas and early-stage suggestions.
7070

71-
> ![NOTE]
71+
> [!NOTE]
7272
> For larger or more extensive changes, we have a formal [proposal process](#propose-a-specification-change) to give more structure where it's needed.
7373
7474
The best issues give a clear and concise explanation of the problem at hand, and ideally some examples of what the problem is.
@@ -104,14 +104,14 @@ We make extensive use of labels.
104104
The main categories are:
105105

106106
- [Housekeeping](https://github.com/OAI/OpenAPI-Specification/labels/Housekeeping) for meetings, project logistics, etc.
107-
- [approved pr port](https://github.com/OAI/OpenAPI-Specification/labels/approved pr port) for pull requests that repeat a change from one version to another
107+
- [approved pr port](https://github.com/OAI/OpenAPI-Specification/labels/approved%20pr%20port) for pull requests that repeat a change from one version to another
108108
- most other tags are used to group similar or related issues into topic areas; this list is ever-changing
109109

110110
Labels related to [issue automation](#appendix-issue-automation)
111111

112-
- [Needs attention](https://github.com/OAI/OpenAPI-Specification/labels/Needs attention) automated tag when an issue is updated
113-
- [Needs author feedback](https://github.com/OAI/OpenAPI-Specification/labels/Needs author feedback) used to indicate that more information is needed from the issue creator
114-
- [No recent activity](https://github.com/OAI/OpenAPI-Specification/labels/No recent activity) if no information is received, the issue is marked for closure (automatic after 30 days)
112+
- [Needs attention](https://github.com/OAI/OpenAPI-Specification/labels/Needs%20attention) automated tag when an issue is updated
113+
- [Needs author feedback](https://github.com/OAI/OpenAPI-Specification/labels/Needs%20author%20feedback) used to indicate that more information is needed from the issue creator
114+
- [No recent activity](https://github.com/OAI/OpenAPI-Specification/labels/No%20recent%20activity) if no information is received, the issue is marked for closure (automatic after 30 days)
115115

116116
### Milestones
117117

@@ -163,13 +163,13 @@ Draft pull requests can still be reviewed while in draft state.
163163

164164
## Reviewers
165165

166-
> ![NOTE]
166+
> [!NOTE]
167167
> See also the detailed team outlines in the [roles section](#roles).
168168
169169
All pull requests must be reviewed and approved by one member of the TSC or Maintainer teams.
170170
Reviews from other contributors are always welcome.
171171

172-
Additionally, all pull requests that change the specification file `spec/oas.md` must be approved by 2 TSC members.
172+
Additionally, all pull requests that change the specification file `spec/oas.md` must be approved by two TSC members.
173173

174174
Reviews requesting changes should have their changes addressed regardless of how many other approvers there are.
175175

@@ -189,7 +189,7 @@ This section relates to the 3.x versions only.
189189

190190
### Minor Releases
191191

192-
Our roadmap for 3.x releases is community-driven, meaning the specification is open for proposed additions by anyone (see [Proposals for Specification Changes](#proposals-for-specification-changes)), in addition to the issues already on the project backlog.
192+
Our roadmap for 3.x releases is community-driven, meaning the specification is open for proposed additions by anyone (see [Propose a Specification Change](#propose-a-specification-change)), in addition to the issues already on the project backlog.
193193

194194
Changes in minor releases (such as 3.2, 3.3) meet the following criteria:
195195

@@ -289,7 +289,7 @@ To get in touch with other people on the project, ask questions, or anything els
289289
- Start a [GitHub Discussion](https://github.com/OAI/OpenAPI-Specification/discussions/).
290290
- 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).
291291

292-
### Appendix: Historical branch strategy
292+
### Appendix: Branch strategy
293293

294294
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).
295295

0 commit comments

Comments
 (0)