-
Notifications
You must be signed in to change notification settings - Fork 9.2k
minor edits #1147
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
minor edits #1147
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,51 @@ | ||
| ## Development Guidelines | ||
|
|
||
| This document intends to establish guidelines which build a transparent, open mechanism for deciding how to evolve the OpenAPI Specification. The Open API Technical Contributor Board will initially follow these processes when merging changes from external contributors or from the TCB itself. This guideline document will be adjusted as it makes sense. | ||
| This document intends to establish guidelines which build a transparent, open mechanism for deciding how to evolve the OpenAPI Specification. The Open API Technical Contributor Board will initially follow these processes when merging changes from external contributors or from the TCB itself. This guideline document will be adjusted as practicality dictates. | ||
|
|
||
| ## OAI Specification Driving factors | ||
|
|
||
| The OpenAPI Specification should be use-case driven. We can write support for hypothetical use cases as we see fit, but they should be backed by realistic scenarios | ||
| 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. | ||
|
|
||
| ## Specification Change Criteria | ||
|
|
||
| The specification _will change_ from the original 2.0 version. We should typically do so when any of the following criteria are met: | ||
| The specification _will change_ from the original 2.0 version. We should typically make changes when any of the following criteria are met: | ||
|
|
||
| - Clarity. The current "way" something is done doesn't make sense, is complicated, or not clear | ||
| - Consistency. A portion of the specification is not consistent with the rest, or the industry standard terminology | ||
| - Necessary functionality. We are missing functionality because of a certain design of the specification | ||
| - Forward-looking designs. As usage of APIs evolves to new protocols, formats, patterns, we should always be considering what the next important functionality should be | ||
| - Clarity. The current "way" something is done doesn't make sense, is complicated, or not clear. | ||
| - Consistency. A portion of the specification is not consistent with the rest, or with the industry standard terminology. | ||
| - Necessary functionality. We are missing functionality because of a certain design of the specification. | ||
| - Forward-looking designs. As usage of APIs evolves to new protocols, formats, and patterns, we should always consider what the next important functionality should be. | ||
| - Impact. A change will provide impact on a large number of use cases. We should not be forced to accommodate every use case. We should strive to make the _common_ and _important_ use cases both well supported and common in the definition of the OAI Spec. We cannot be edge-case driven. | ||
|
|
||
|
|
||
| ## Tracking Process | ||
|
|
||
| - Use GitHub for all spec designs, use cases, etc. | ||
| - Use GitHub for all spec designs, use cases, and so on. | ||
| - As with 2.0, the **human readable** document is the source of truth. If using a JSON Schema again to document the spec, it is secondary to the human documentation. The documentation should live in a *.md file, in parallel to the 2.0 document (versions/3.0.md for example). | ||
| - The `master` branch shall remain the current, released OpenAPI Specification (i.e. 2.0). We will work in an OpenAPI.next branch, which shall be described and linked to on the **default** README.md on master | ||
| - Examples of how something is described _currently_ vs. the proposed solution should accompany any change proposal | ||
| - New features should be done in feature branches which, upon approval, be merged into the OpenAPI.next branch. | ||
| - Use labels for the workflow of specification changes. For example, this may be labeled as `proposed`, `needs migration review`, `needs tooling review`, `needs documentation`, `rejected`, `needs approval`. These labels must be assigned by project committers | ||
| - An issue will be opened for each feature change. Embedded in the issue OR ideally linked in a file via pull-request (PR), a document should be supplied for use cases for the change | ||
| - A PR will be used to describe the _proposed_ solution, and linked to the original issue | ||
| - Not all committers will contribute to every single proposed change. There may be many open proposals at once, and multiple efforts may happen in parallel | ||
| - The `master` branch shall remain the current, released OpenAPI Specification (i.e., 2.0). We will work in an OpenAPI.next branch, which shall be described and linked to on the **default** README.md on master. | ||
| - Examples of how something is described _currently_ vs. the proposed solution should accompany any change proposal. | ||
| - New features should be done in feature branches which, upon approval, are merged into the OpenAPI.next branch. | ||
| - Use labels for the workflow of specification changes. Examples of labels are `proposed`, `needs migration review`, `needs tooling review`, `needs documentation`, `rejected`, and `needs approval`. These labels must be assigned by project committers. | ||
| - An issue will be opened for each feature change. Embedded in the issue, or ideally linked in a file via pull-request (PR), a document about use cases should be supplied with the change. | ||
| - A PR will be used to describe the _proposed_ solution, and linked to the original issue. | ||
| - Not all committers will contribute to every single proposed change. There may be many open proposals at once, and multiple efforts may happen in parallel. | ||
| - When the OpenApi.next spec is complete and approved for release, the branch will be merged to master. | ||
|
|
||
| ## Approving Changes | ||
|
|
||
| For each change in the specification we should _always_ consider the following: | ||
|
|
||
| - Migration. Is this a construct that has a path from the existing 2.0 specification? If so, how complicated is it to migrate to the proposed change? | ||
| - Tooling. Strive to support code generation, software interfaces, spec generation techniques. Some features may be impossible to support in different frameworks/languages. These should be documented and considered if the change should be approved. | ||
| - Visualization. Can the specification change be graphically visualized somehow in a UI or other? | ||
| - Tooling. Strive to support code generation, software interfaces, and spec generation techniques. Some features may be impossible to support in different frameworks/languages. These should be documented and considered during the change approval process. | ||
| - Visualization. Can the specification change be graphically visualized somehow in a UI or other interface? | ||
|
|
||
| Spec changes should be approved by a majority of the committers. This can be done by commenting on the issue itself ("Approved by @fehguy" for example). Once voting criteria is met, any committer can merge the PR. (**TODO: we will want to formalize what voting criteria actually is). | ||
| Spec changes should be approved by a majority of the committers. Approval can be given by commenting on the issue itself, for example, "Approved by @fehguy". After voting criteria is met, any committer can merge the PR. (**TODO: we will want to formalize what voting criteria actually is). | ||
|
|
||
| No change should be approved until there is documentation for it, supplied in an accompanying PR. | ||
|
|
||
| ## Transparency | ||
|
|
||
| We should always be as transparent as possible. Sometimes there will be discussions that use customer names, sensitive use cases, etc. These must be anonymized, discussed in a private repository, or offline | ||
| We should always be as transparent as possible. Sometimes there will be discussions that use customer names, sensitive use cases, and so on. These must be anonymized, discussed in a private repository, or conducted offline. | ||
|
|
||
| - Asynchronous discussions should live in the GitHub issues for this project | ||
| - Realtime discussions should be in a public chat such as IRC or Slack | ||
| - Asynchronous discussions should live in the GitHub issues for this project. | ||
| - Realtime discussions should be in a public chat such as IRC or Slack. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you are changing this paragraph, could you close the
**here after the TODO? I guess markdown's in-line markup should close itself at the end of the paragraph, but Github's diff view doesn't seem to know this.)