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: CONTRIBUTING.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing to the OpenAPI Specification
2
2
3
-
***Work in progress!***
3
+
***Work in progress!** Each section links to issues that are relevant to fill out the rest of this document.*
4
4
5
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
6
@@ -38,7 +38,7 @@ Schemas are only changed _after_ the specification is changed. Changes are made
* Issue #3529: [3.x minor 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
42
* Issue #3715: [Define and document our schema publishing process](https://github.com/OAI/OpenAPI-Specification/issues/3715)
43
43
* Issue #3785: [Style guide / release checklist for the specification](https://github.com/OAI/OpenAPI-Specification/issues/3785)
44
44
@@ -68,12 +68,12 @@ Bigger changes require a more formal process.
68
68
69
69
4. If the suggested change has good support, you will be asked to create a formal proposal.
70
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.
71
+
Once you the document is ready, open a pull request on the main branch.
72
72
73
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 to the `main` branch and a final pull request is opened to add the feature to the appropriate version of the specification.
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
75
76
-
Questions are welcome on the process and at any time. Use the discussions feature or find us in Slack.
76
+
Questions are welcome on the process at any time. Use the discussions feature or find us in Slack.
77
77
78
78
## Working in GitHub
79
79
@@ -95,7 +95,7 @@ The OpenAPI Initiative uses GitHub Projects to manage work _outside_ of the spec
95
95
96
96
### Discussions
97
97
98
-
We are beginning (as of mid-2024) to use GitHub [discussions](https://github.com/OAI/Arazzo-Specification/discussions?discussions_q=is%3Aopen) for open-ended topics such as major enhancements.
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
99
100
100
* Issue #3518: [Define criteria for filing/closing issues vs discussions](https://github.com/OAI/OpenAPI-Specification/issues/3518)
101
101
@@ -111,13 +111,13 @@ In an effort to keep the list of issues up to date and easier to navigate throug
111
111
112
112
This process makes use of the following labels:
113
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.
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
117
118
118
### Automated TDC agenda issues Process
119
119
120
-
An issue is opened every week, 7 days in advance, for the Technical Direction Committee (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".
120
+
An issue is opened every week, 7 days in advance, for the Technical Developer Committee (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
121
122
122
Ten (10) days after the meeting date is passed (date in the title of the issue), it gets closed and unpinned automatically.
0 commit comments