Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add branch strategy to README #1149

Merged
merged 10 commits into from
Nov 16, 2024
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,16 @@ This repository consists of these files and directories (partial):
- `mkdocs.yml` - MkDocs recipe for the spec documentation generation. The
inclusion of model files and the order of chapters are defined here.

## Branch structre

The SPDX spec repo follows the [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) 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 will take place. Once relased, 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.

## Related documents and repositories

| Documentation | Link |
Expand Down