Skip to content

Commit e6bcf1b

Browse files
authored
Merge pull request #110 from lornajane/update-branch-structure
Add information about project branching structure
2 parents 658f3b2 + 115d603 commit e6bcf1b

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,38 @@ Pull requests are also welcome, but it is recommended to create an issue first,
77
Questions and comments are also welcome - use the GitHub Discussions feature.
88
You will also find notes from past meetings in the Discussion tab.
99

10+
## Key information
11+
12+
This project is covered by our [Code of Conduct](https://github.com/OAI/OpenAPI-Specification?tab=coc-ov-file#readme).
13+
All participants are expected to read and follow this code.
14+
15+
No changes, however trivial, are ever made to the contents of published specifications (the files in the `versions/` folder).
16+
Exceptions may be made when links to external documents have been changed by a 3rd party, in order to keep our documents accurate.
17+
18+
Published versions of the specification are in the `versions/` folder.
19+
The under-development versions of the specification are in the file `spec/overlay.md` on the appropriately-versioned branch.
20+
For example, work on the next release for 1.1 is on `v1.1-dev` in the file `spec/overlay.md`.
21+
22+
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.
23+
24+
The OpenAPI project is almost entirely staffed by volunteers.
25+
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.
26+
27+
## Pull Requests
28+
29+
Pull requests are always welcome but please read the section below on [branching strategy](#branching-strategy) before you start.
30+
31+
Pull requests must come from a fork; create a fresh branch on your fork based on the target branch for your change.
32+
33+
### Branching Strategy
34+
35+
Overview of branches:
36+
37+
- `main` holds the published versions of the specification, utility scripts and supporting documentation.
38+
- `dev` is for development infrastructure and other changes that apply to multiple versions of development.
39+
- Branches named `vX.Y-dev` are the active development branches for future releases.
40+
All changes should be applied to the _earliest_ branch where the changes are relevant in the first instance.
41+
1042
## Build the HTML version to publish
1143

1244
We use ReSpec to render the markdown specification as HTML for publishing and easier reading.

0 commit comments

Comments
 (0)