Skip to content

Docs/new branching strategy - #242

Open
khalford wants to merge 1 commit into
developfrom
docs/new_branching_strategy
Open

khalford wants to merge 1 commit into
developfrom
docs/new_branching_strategy

Conversation

@khalford

@khalford khalford commented Oct 9, 2026 •

Copy link
Copy Markdown
Member

Updated the README to describe the Git branching flow we should use for this project. It follows the usual discipline of feature -> staging -> main.

Adds information on how hotfixes should be handled.

Adds a GitHub workflow to enforce the branch merging rules

@khalford khalford self-assigned this Oct 9, 2026
@khalford
khalford requested a review from a team as a code owner October 9, 2026 10:43
@khalford khalford added documentation Improvements or additions to documentation OS Images labels Oct 9, 2026
@khalford
khalford force-pushed the docs/new_branching_strategy branch from c1edba4 to 08e0789 Compare October 9, 2026 10:48
@khalford
khalford force-pushed the docs/new_branching_strategy branch from 08e0789 to 40a14f0 Compare October 9, 2026 11:32
@gmatthews20

Copy link
Copy Markdown
Contributor

I am curious why GitFlow was chosen as its not obvious to me of the benefits over say feat/fix -> staging -> main?

@khalford

Copy link
Copy Markdown
Member Author

I am curious why GitFlow was chosen as its not obvious to me of the benefits over say feat/fix -> staging -> main?

You're right. I will make a new commit

@khalford
khalford force-pushed the docs/new_branching_strategy branch from 40a14f0 to 1af87d1 Compare October 29, 2026 09:11
Update the Git branch workflow in the README.md. This follows the
feature -> staging -> main workflow. Hopefully this will fix issues we have had with
features that are not ready to ship being merged into the release
branches. It also describes how hot fixes should be done.

I have created a new GitHub workflow to enforce branch merging rules.
@khalford
khalford force-pushed the docs/new_branching_strategy branch from 1af87d1 to 17479fd Compare October 29, 2026 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation OS Images

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants