You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## Development Guidelines
2
2
3
-
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.
3
+
This document establishes guidelines which build a transparent, open mechanism for deciding how to evolve the OpenAPI Specification. The OpenAPI Technical Developer Community (TDC) will initially follow these processes when merging changes. This guideline document will be adjusted as practicality dictates.
4
4
5
5
## OAI Specification Driving factors
6
6
@@ -38,7 +38,7 @@ For each change in the specification we should _always_ consider the following:
38
38
- 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.
39
39
- Visualization. Can the specification change be graphically visualized somehow in a UI or other interface?
40
40
41
-
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).
41
+
Spec changes should be approved by a majority of the maintainers. Approval can be given by commenting on the pull request (PR) itself, for example, "Approved by @fehguy" or "LGTM". After voting criteria is met, any maintainer can merge the PR. (**TODO**: we will want to formalize what voting criteria actually is).
42
42
43
43
No change should be approved until there is documentation for it, supplied in an accompanying PR.
44
44
@@ -47,5 +47,5 @@ No change should be approved until there is documentation for it, supplied in an
47
47
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.
48
48
49
49
- Asynchronous discussions should live in the GitHub issues for this project.
50
-
- Realtime discussions should be in a public chat such as IRC or Slack.
50
+
- Realtime discussions should be in a public chat such as IRC or the #spec channel on the OpenAPI Slack.
0 commit comments