|
| 1 | +# Contributing to the OpenAPI Specification |
| 2 | + |
| 3 | +***Work in progress!** Each section links to issues that are relevant to fill out the rest of this document.* |
| 4 | + |
| 5 | +We are currently working on [defining and documenting our new processes](https://github.com/orgs/OAI/projects/5). Information in this document is up-to-date. Older _(and sometimes now inaccurate)_ documentation can be found in [DEVELOPMENT.md](DEVELOPMENT.md), which will be removed when everything is updated and documented here. |
| 6 | + |
| 7 | +## Essential Policies |
| 8 | + |
| 9 | +This section serves as a quick guide while we work on the full updated documentation. |
| 10 | + |
| 11 | +If in doubt about a policy, please [ask on our Slack](https://communityinviter.com/apps/open-api/openapi) before opening a PR. |
| 12 | + |
| 13 | +### No changes to published specifications |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | +### Current branches and documents open to change |
| 18 | + |
| 19 | +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. |
| 20 | + |
| 21 | +The current (31 July 2024) active releases are: |
| 22 | + |
| 23 | +| Version | Branch | File | Notes | |
| 24 | +| ------- | ------ | ---- | ----- | |
| 25 | +| 3.0.4 | `v3.0.4-dev` | `versions/3.0.4.md` | Soon to be published | |
| 26 | +| 3.1.1 | `v3.1.1-dev` | `versions/3.1.1.md` | Soon to be published | |
| 27 | +| 3.2.0 | `v3.2.0-dev` | `versions/3.2.0.md` | Planned for late 2024 | |
| 28 | +| 4.0.0 | [OAI/sig-moonwalk](https://github.com/OAI/sig-moonwalk) | [discussions only](https://github.com/OAI/sig-moonwalk/discussions) | TBD, some proposals to be backported and published in 3.2.0 | |
| 29 | + |
| 30 | +### Changing the schemas |
| 31 | + |
| 32 | +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. |
| 33 | + |
| 34 | +## Authoritative source of truth |
| 35 | + |
| 36 | +* Issue #3576: [What is our authoritative spec URL and how do people find it?](https://github.com/OAI/OpenAPI-Specification/issues/3576) |
| 37 | + |
| 38 | +## Release Process and Scope |
| 39 | + |
| 40 | +* Issue #3528: [3.x.y patch release approach](https://github.com/OAI/OpenAPI-Specification/issues/3528) |
| 41 | +* Issue #3529: [3.x minor release approach](https://github.com/OAI/OpenAPI-Specification/issues/3529) |
| 42 | +* Issue #3715: [Define and document our schema publishing process](https://github.com/OAI/OpenAPI-Specification/issues/3715) |
| 43 | +* Issue #3785: [Style guide / release checklist for the specification](https://github.com/OAI/OpenAPI-Specification/issues/3785) |
| 44 | + |
| 45 | +## Branching and Versioning |
| 46 | + |
| 47 | +* Issue #3677: [Define and document branch strategy for the spec, both development and publishing](https://github.com/OAI/OpenAPI-Specification/issues/3677) |
| 48 | + |
| 49 | +## Proposals for Specification Changes |
| 50 | + |
| 51 | +As an organisation, we're open to changes, and these can be proposed by anyone. |
| 52 | +The specification is very widely adopted, and there is an appropriately high bar for wide appeal and due scrutiny as a result. |
| 53 | +We do not accept changes lightly (but we will consider any that we can). |
| 54 | + |
| 55 | +Small changes are welcome as pull requests. |
| 56 | + |
| 57 | +Bigger changes require a more formal process. |
| 58 | + |
| 59 | +1. Start a [discussion](https://github.com/OAI/OpenAPI-Specification/discussions) of type "Enhancements". |
| 60 | + The discussion entry must include some use cases, your proposed solution and the alternatives you have considered. |
| 61 | + If there is engagement and support for the proposal over time, then it can be considered as a candidate to move to the next stage. |
| 62 | + |
| 63 | +2. It really helps to see the proposed change in action. |
| 64 | + Start using it as a `x-*` extension if that's appropriate, or try to bring other evidence of your proposed solution being adopted. |
| 65 | + |
| 66 | +3. If you are adding support for something from another specification (such as OAuth), please point to implementations of that |
| 67 | + specification so that we can understand how, and to what degree, it is being used. |
| 68 | + |
| 69 | +4. If the suggested change has good support, you will be asked to create a formal proposal. |
| 70 | + Use the [template in the proposals directory](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals), copy it to a new file, and complete it. |
| 71 | + Once you the document is ready, open a pull request on the main branch. |
| 72 | + |
| 73 | +5. The proposal will be more closely reviewed and commented on or amended until it is either rejected or accepted. |
| 74 | + At that point, the proposal is merged into the `main` branch and a pull request is opened to add the feature to the appropriate `dev` version of the specification. |
| 75 | + |
| 76 | +Questions are welcome on the process at any time. Use the discussions feature or find us in Slack. |
| 77 | + |
| 78 | +## Working in GitHub |
| 79 | + |
| 80 | +* Issue #3847: [Document milestone usage in DEVELOPMENT.md](https://github.com/OAI/OpenAPI-Specification/issues/3847) |
| 81 | +* Issue #3848: [Define and add new process labels and document general label usage in DEVELOPMENT.md](https://github.com/OAI/OpenAPI-Specification/issues/3848) |
| 82 | + |
| 83 | +### Roles and Permissions |
| 84 | + |
| 85 | +* Issue #3582: [TOB info needs to be updated](https://github.com/OAI/OpenAPI-Specification/issues/3482) |
| 86 | +* Issue #3523: [Define triage role criteria and process](https://github.com/OAI/OpenAPI-Specification/issues/3523) |
| 87 | +* Issue #3524: [Define the maintainer role criteria and process](https://github.com/OAI/OpenAPI-Specification/issues/3524) |
| 88 | + |
| 89 | +### Projects |
| 90 | + |
| 91 | +The OpenAPI Initiative uses GitHub Projects to manage work _outside_ of the specification development process. There are currently two active projects: |
| 92 | + |
| 93 | +* [Contributor Guidance](https://github.com/orgs/OAI/projects/5/views/1) |
| 94 | +* [Automation & Infrastructure](https://github.com/orgs/OAI/projects/4/views/1) |
| 95 | + |
| 96 | +### Discussions |
| 97 | + |
| 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. |
| 99 | + |
| 100 | +* Issue #3518: [Define criteria for filing/closing issues vs discussions](https://github.com/OAI/OpenAPI-Specification/issues/3518) |
| 101 | + |
| 102 | +### Issues |
| 103 | + |
| 104 | +As of mid-2024, we prefer to use issues for topics that have a clear associated action. However, many existing issues are more open-ended, as they predate GitHub's discussions features. |
| 105 | + |
| 106 | +* Issue #3518: [Define criteria for filing/closing issues vs discussions](https://github.com/OAI/OpenAPI-Specification/issues/3518) |
| 107 | + |
| 108 | +### Automated closure of issues Process |
| 109 | + |
| 110 | +In an effort to keep the list of issues up to date and easier to navigate through, issues get closed automatically when they become inactive. |
| 111 | + |
| 112 | +This process makes use of the following labels: |
| 113 | + |
| 114 | +* `Needs author feedback`: the issue has been replied to by the triage team and is awaiting a follow up from the issue's author. This label needs to be added manually by people doing triage/experts whenever they reply. It's removed automatically by the workflow. |
| 115 | +* `No recent activity`: the issue hasn't received a reply from its author within the last 10 days since `Needs author feedback` was added and will be closed within 28 days if the author doesn't follow up. This label is added/removed automatically by the workflow. |
| 116 | +* `Needs attention`: The issue's author has replied since the `Needs author feedback` label was set and the triage team will reply as soon as possible. This label needs to be removed manually by people doing triage/experts whenever they reply. It's added automatically by the workflow. |
| 117 | + |
| 118 | +### Automated TDC agenda issues Process |
| 119 | + |
| 120 | +An issue is opened every week, 7 days in advance, for the Technical Developer Community (TDC), it provides the information to connect the meeting, and serves as a placeholder to build the agenda for the meeting. Anyone is welcome to attend the meeting, or to add items to the agenda as long as they plan on attending to present the item. These issues are also automatically pinned for visibility and labeled with "Housekeeping". |
| 121 | + |
| 122 | +Ten (10) days after the meeting date is passed (date in the title of the issue), it gets closed and unpinned automatically. |
| 123 | + |
| 124 | +## Pull Requests |
| 125 | + |
| 126 | +* Issue #3581: [Who and how many people need to sign-off on a PR, exactly?](https://github.com/OAI/OpenAPI-Specification/issues/3581) |
| 127 | +* Issue #3802: [Define a policy using draft PRs when waiting on specific approvals](https://github.com/OAI/OpenAPI-Specification/issues/3802) |
| 128 | + |
| 129 | +## Updating the Registries |
| 130 | + |
| 131 | +* Issue #3598: [Minimum criteria for Namespace Registry](https://github.com/OAI/OpenAPI-Specification/issues/3598) |
| 132 | +* Issue #3899: [Expert review criteria for registries (How exactly does x-twitter work?)](https://github.com/OAI/OpenAPI-Specification/issues/3899) |
0 commit comments