From 0268923743bf90e54e02fe9e82744c8b0cd752d6 Mon Sep 17 00:00:00 2001 From: Lorna Jane Mitchell Date: Tue, 17 Dec 2024 09:16:33 +0000 Subject: [PATCH 1/3] Add branching strategy info and some key information to the contributing file --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3a74309..666fa1c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,38 @@ Pull requests are also welcome, but it is recommended to create an issue first, Questions and comments are also welcome - use the GitHub Discussions feature. You will also find notes from past meetings in the Discussion tab. +## Key information + +This project is covered by our [Code of Conduct](https://github.com/OAI/OpenAPI-Specification?tab=coc-ov-file#readme). +All participants are expected to read and follow this code. + +No changes, however trivial, are ever made to the contents of published specifications (the files in the `versions/` folder). +Exceptions may be made when links to external URLs have been changed by a 3rd party, in order to keep our documents accurate. + +Published versions of the specification are in the `versions/` folder. +The under-development versions of the specification are in the file `spec/overlay.md` on the appropriately-versioned branch. +For example, work on the next release for 1.1 is on `v1.1-dev` in the file `spec/overlay.md`. + +The [spec site](https://spec.openapis.org) is the source of truth for the OpenAPI Overlay specification as it contains all the citations and author credits. + +The OpenAPI project is almost entirely staffed by volunteers. +Please be patient with the people in this project, who all have other jobs and are active here because we believe this project has a positive impact in the world. + +## Pull Requests + +Pull requests are always welcome but please read the section below on [branching strategy](#branching-strategy) before you start. + +Pull requests must come from a fork; create a fresh branch on your fork based on the target branch for your change. + +### Branching Strategy + +Overview of branches: + +- `main` holds the published versions of the specification, utility scripts and supporting documentation. +- `dev` is for development infrastructure and other changes that apply to multiple versions of development. +- Branches named `vX.Y-dev` are the active development branches for future releases. + All changes should be applied to the _earliest_ branch where the changes is relevant in the first instance. + ## Build the HTML version to publish We use ReSpec to render the markdown specification as HTML for publishing and easier reading. From 8a9ca7a2a46f3c001ac6a844fa339393ffb3c4c5 Mon Sep 17 00:00:00 2001 From: Lorna Jane Mitchell Date: Tue, 17 Dec 2024 10:12:45 +0000 Subject: [PATCH 2/3] Update CONTRIBUTING.md Co-authored-by: Ralf Handl --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 666fa1c..d5221ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,7 +37,7 @@ Overview of branches: - `main` holds the published versions of the specification, utility scripts and supporting documentation. - `dev` is for development infrastructure and other changes that apply to multiple versions of development. - Branches named `vX.Y-dev` are the active development branches for future releases. - All changes should be applied to the _earliest_ branch where the changes is relevant in the first instance. + All changes should be applied to the _earliest_ branch where the changes are relevant in the first instance. ## Build the HTML version to publish From 115d603eda37a05f4db70f71ad2a9ae3ebdf9f70 Mon Sep 17 00:00:00 2001 From: Lorna Jane Mitchell Date: Tue, 17 Dec 2024 11:06:34 +0000 Subject: [PATCH 3/3] Update CONTRIBUTING.md Co-authored-by: Ralf Handl --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d5221ca..fdbd4b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ This project is covered by our [Code of Conduct](https://github.com/OAI/OpenAPI- All participants are expected to read and follow this code. No changes, however trivial, are ever made to the contents of published specifications (the files in the `versions/` folder). -Exceptions may be made when links to external URLs have been changed by a 3rd party, in order to keep our documents accurate. +Exceptions may be made when links to external documents have been changed by a 3rd party, in order to keep our documents accurate. Published versions of the specification are in the `versions/` folder. The under-development versions of the specification are in the file `spec/overlay.md` on the appropriately-versioned branch.