Commit f3d0136e authored by Emmanuel Promayon's avatar Emmanuel Promayon

Update CamiTK_Git_Branching_Model.md

parent 29b7cde4
Pipeline #30700 passed with stages
in 39 seconds
......@@ -131,43 +131,31 @@ master branch with a hotfix tag and the develop branch too.
Here is the naming conventions adopted In CamiTK team to name branches
At the creation.
- **Feature**:
- If the features was declared as a story In CamiTK agile
management system or gitlab: the branch should be named
*feature/\#* (*feature/\#321* for example). Note: if the new
feature was opened on bugzilla, first create an issue in gitlab.
- If the new feature was not declared as a story, the branch
should be named *feature/XXX* where *XXX* is a comprehensible
(although rather short) description (e.g.,
*feature/connect-to-camitk-store*).
- **Feature**: The feature branch should be named `feature/XXX` where `XXX` is a comprehensible
(although rather short) description (e.g., `feature/connect-to-camitk-store`). Do not hesitate
to use multiple words separated by `-` (dashes).
<!-- -->
- **Bug fix**:
- If the bug was opened on bugzilla, the branch should Be named
*bug/\#* followed directly by the bugzilla bug id (e.g.,
*bug/\#181*). Note: an artifact in gitlab should also has been
created.
- If the bug was not opened on bugzilla, the branch should Be
named *bug/XXX* where *XXX* is a comprehensible (although rather
short) description (e.g., *bug/parallel-build*).
- **Bug fix**: The bug branch should be named `bug/XXX` where `XXX` is a comprehensible
(although rather short) description (e.g., `bug/parallel-build`). Do not hesitate
to use multiple words separated by `-` (dashes).
<!-- -->
- **Hotfix**: the branch should be called hotfix/ (*hotfix/4. 0. 1*
for example).
- **Hotfix**: the branch should be called `hotfix/x.y.z` (`hotfix/4.0.1` for example).
<!-- -->
- **Release**: the branch should be called release/\< (*release/4. 0.
0* for example)
- **Release**: the branch should be called `release/x.y.z` (`release/4.0.0` for example)
<!-- -->
- **Tag**: Use tag to add a label to the commit that correspond to the
release or hotfix (e.g., for a release: *4.0.0* or *4.1.0*, and for
a hotfix: *4.0.1 or 4.0.2*)
release or hotfix (e.g., for a release: `4.0.0` or `4.1.0`, and for
a hotfix: `4.0.1` or `4.0.2`)
## References
[^1]: [“A successful Git branching
model”](http://nvie.com/posts/a-successful-git-branching-model/)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment