diff --git a/README.md b/README.md index deccc7b28..285d41af1 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,18 @@ All use cases supported by the prior version are supported here as well. This repository holds the model for the information captured in SPDX version 3 standard. -## Branches and Formats +## Branch Structure + +The SPDX 3 model repo follows the [Gitflow](https://gist.github.com/HeratPatel/271b5d2304de2e2cd1823b9b62bf43e0) workflow with the addition of support branches. + +The branches in use are: + +- `main` - This will always be the latest released specification. +- `develop` - This branch will be where the active development for the next major or minor version takes place. Once released, the `develop` branch will be merged into the `main` branch. +- `support/x.y` - These branches will be long lived and contain any updates to a minor version of the specification. Additions such as translations can be added to the support branch. `x.y` represents the major.minor version. Once any changes are accepted and released, the support branch will be tagged and merged into both the develop and main branches. +- General feature or fix branches - there may be feature branches made for specific enhancements or fixes to the spec. These will be short lived and merged into either a support branch or the develop branch. + +## Formats The editable files inside `model/` directory are written in a [constrained subset of Markdown][format],