Skip to content

Commit e9f3792

Browse files
authored
Merge pull request #3599 from handrews/dev
Add essential policies to DEVELOPMENT.md
2 parents f466c87 + 4a11c66 commit e9f3792

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

DEVELOPMENT.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,31 @@
22

33
This document intends to establish guidelines which build a transparent, open mechanism for deciding how to evolve the OpenAPI Specification. The OpenAPI Technical Steering Committee (TSC) will initially follow these processes when merging changes from external contributors or from the TSC itself. This guideline document will be adjusted as practicality dictates.
44

5+
### Essential Policies
6+
7+
If in doubt about a policy, please [ask on our Slack](https://communityinviter.com/apps/open-api/openapi) before opening a PR.
8+
9+
#### No changes to published specifications
10+
11+
No changes, ***no matter how trivial***, are ever made to the contents of published specifications. The only potential changes to those documents are updates to link URLs _if and only if_ the targeted document is moved by a 3rd party. Other changes to link URLs are not allowed.
12+
13+
#### Current branches and documents open to change
14+
15+
The first PR for a change should be against the oldest release line to which it applies. Changes can then be forward-ported as appropriate.
16+
17+
The current (February 2024) active releases are:
18+
19+
| Version | Branch | File |
20+
| ------- | ------ | ---- |
21+
| 3.0.4 | `v3.0.4-dev` | `versions/3.0.4.md` |
22+
| 3.1.1 | `v3.1.1-dev` | `versions/3.1.1.md` |
23+
| 3.2.0 | `v3.2.0-dev` | `versions/3.2.0.md` |
24+
| 4.0.0 | [OAI/sig-moonwalk](https://github.com/OAI/sig-moonwalk) | [discussions only](https://github.com/OAI/sig-moonwalk/discussions) |
25+
26+
#### Changing the schemas
27+
28+
Schemas are only changed _after_ the specification is changed. Changes are made on the `main` branch, and should be made to the YAML version _only_. The JSON version will be generated automatically.
29+
530
## OAI Specification Driving factors
631

732
The OpenAPI Specification should be use-case driven. We can specify support for hypothetical use cases as we see fit, but specifications should be backed by realistic scenarios.

0 commit comments

Comments
 (0)