diff options
| author | Riku Isokoski <riksu9000@gmail.com> | 2022-08-21 14:50:09 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-21 14:50:09 +0300 |
| commit | c2b6a8de3e15fa66d48a373b3504fcebf12d905b (patch) | |
| tree | 53e019a0a47d69092dbd02b2a216b66f05a88581 /doc/branches.md | |
| parent | c495db8a71675fac3f48f8421b3035b318c3dd82 (diff) | |
Fix markdown format with autoformatter (#1284)
Diffstat (limited to 'doc/branches.md')
| -rw-r--r-- | doc/branches.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/branches.md b/doc/branches.md index c12c764a..cf98684b 100644 --- a/doc/branches.md +++ b/doc/branches.md @@ -1,12 +1,14 @@ # 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 is based on 2 main branches: - - **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. + +- **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. 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.
\ No newline at end of file +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. |