Update Developer guide - git-flow authored by Bouvry Arnaud's avatar Bouvry Arnaud
---
title: Developer guide
---
# Table of contents
[[_TOC_]]
......@@ -17,7 +15,44 @@ All contributions are welcome. To start coding :
- **NEVER** `git add .` or `git add -A` or `git add -A .`
# Branching strategy : git-flow
2 permanent branches : main and develop
source : https://nvie.com/posts/a-successful-git-branching-model/
## main branch
branch where the source code of `HEAD` always reflects a _production-ready_ state
## develop branch
branch where the source code of `HEAD` always reflects a state with the latest delivered development changes for the next release, kind of an '"integration branch'
## The supporting branches: release-* , hotfix-* and feature-*
### release branches
May branch off from:
`develop`
Must merge back into:
`develop` **and** `main`
Branch naming convention:
`release-*`
### hotfix branches
May branch off from:
`main`
Must merge back into:
`develop` and `main`
Branch naming convention:
`hotfix-*`
### feature branches
May branch off from:
`develop`
Must merge back into:
`develop`
Branch naming convention:
anything except `main`, `develop`, `release-*`, or `hotfix-*`
# Branching workflow
......
......