Uh oh!
There was an error while loading. Please reload this page.
Begin DEVELOPMENT.md -> CONTRIBUTING.md - #3984
Conversation
Create a new CONTRIBUTING.md and link it and DEVELOPMENT.md to each other. Move the recent sections over to CONTRIBUTING.md, and outline sections to organize the various topics that have issues tracking them.
| This section serves as a quick guide while we work on the full updated documentation. | ||
| If in doubt about a policy, please [ask on our Slack](https://communityinviter.com/apps/open-api/openapi) before opening a PR. |
There was a problem hiding this comment.
Can we have two links here, this one for new participants to sign up, and another one for existing participants that directly leads to the #spec channel?
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| 4. If the suggested change has good support, you will be asked to create a formal proposal. | ||
| 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. | ||
| Once you the document is ready, open a pull request. |
There was a problem hiding this comment.
| Once you the document is ready, open a pull request. | |
| Once you the document is ready, open a pull request to the `main` branch. |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| @@ -1,31 +1,14 @@ | |||
| # CHANGES IN PROGRESS!! | |||
| Please see [CONTRIBUTING.md](CONTRIBUTING.md) for up-to-date guidelines. While we continue to [define and document our new processes](https://github.com/orgs/OAI/projects/5), we will keep this document as much of its contents are still relevant. However, if in doubt about a policy, please [ask on our Slack](https://communityinviter.com/apps/open-api/openapi). | |||
There was a problem hiding this comment.
Also have two Slack links here, one for newcomers, one for returners
| | 3.1.1 | `v3.1.1-dev` | `versions/3.1.1.md` | Soon to be published | | ||
| | 3.2.0 | `v3.2.0-dev` | `versions/3.2.0.md` | Planned for late 2024 | | ||
| | 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 | | ||
There was a problem hiding this comment.
I think we need a section on "Markdown style". We have a set of conventions for how we write the spec documents -- we should capture these here and say that we enforce some of them with markdown lint (if we do). I think it would also be good to document our conventions for RFC and other links.
There was a problem hiding this comment.
@mikekistler this is just to start an outline and populate it with material directly copied over - for additional content, we need to do additoinal PRs.
handrews
commented
Aug 1, 2024
@ralfhandl@mikekistler I've included all the minor stuff. I don't know how to do the slack thing you want, so please handle that and other requested changes or additions as future PRs- this is just to get the skeleton and port over the sections that could be taken more-or-less verbatim. |
mikekistler
left a comment
There was a problem hiding this comment.
This looks good as the initial restructure. As @handrews says, there is more to do but I'm fine with leaving that work to future PRs.
Uh oh!
There was an error while loading. Please reload this page.
@mikekistler Please reapprove & merge |
Create a new CONTRIBUTING.md and link it and DEVELOPMENT.md to each other. Move the recent sections over to CONTRIBUTING.md, and outline sections to organize the various topics that have issues tracking them.