diff options
Diffstat (limited to 'doc/branches.md')
| -rw-r--r-- | doc/branches.md | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/doc/branches.md b/doc/branches.md index cf98684b..93b04908 100644 --- a/doc/branches.md +++ b/doc/branches.md @@ -1,14 +1,12 @@ # Branches -The branching model of this project is based on the workflow named [Git flow](https://nvie.com/posts/a-successful-git-branching-model/). +The project has 1 main branch, aptly called **main**. +This branch contains the latest development that will be tagged for the next release once it's considered stable. -The project is based on 2 main branches: +New features should be implemented in **feature branches** created from **main**. +When the feature is ready, a pull request is created and it'll be merged into **main** when it is successfully reviewed and accepted. -- **master** : this branch is always ready to be deployed. It means that at any time, we should be able to build the branch and release a new version of the application. -- **develop** : this branch contains the latest development that will be integrated in the next release once it's considered as stable. +To release a new version of the application, when main is considered stable, a tag is created on the version bump commit in **main** and the release is generated (a tag is applied to git, the release note is finalized, binaries are built,...). -New features should be implemented in **feature branches** created from **develop**. When the feature is ready, a pull-request is created and it'll be merge into **develop** when it is successfully reviewed and accepted. - -To release a new version of the application, when develop is considered stable, a **release** branch is created from **develop**. This can be considered as a *release candidate* branch. When everything is OK, this release branch is merged into **master** and the release is generated (a tag is applied to git, the release note is finalized, binaries are built,...) from **master**. - -Git flow also supports the creation of **hotfix** branches when a bug is discovered in a released version. The **hotfix** branch is created from **master** and will be used only to implement a fix to this bug. Multiple hotfix branches can be created for the same release if multiple bugs are discovered. +We also supports the creation of **hotfix** branches when a bug is discovered in a released version. The **hotfix** branch is created from the latest tag and will be used only to implement a fix to this bug. +Multiple hotfix branches can be created for the same release if multiple bugs are discovered. |