Skip to content

Commit

Permalink
Fixes in the development process doc
Browse files Browse the repository at this point in the history
  • Loading branch information
twebermartins committed Feb 14, 2023
1 parent e945393 commit 25f88ee
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions docs/adr/development_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,17 @@ The *main* branches are :

The `supporting` branches are:
- `feature` branch: This branch can be used to implement new features for the next releases.
- `release` branch: This branch supports the preparation to new releases and only accepts commits (e.g.m minor bug fixes) to stabilize a version of the ready for release (production ready). Release branches should not be created for every release but only per minor version, e.g. `release-v3.1.0`. Each release should be created as a tag.
- `release` branch: This branch supports the preparation to new releases and only accepts commits (e.g. minor bug fixes) to stabilize a version of the code ready for release (production ready). Release branches should not be created for every release but only per major version, e.g. `release-v3.x` without any breaking changes. Each release should be created as a tag.
- `bugfixes` branch: This branch captures work to fix an urgent production defect (issues, error, instabilities, vulnerabilities, ...).

## Processes

- Once the `main` branch achieves the development goals, is stable (production-ready) and ready for release.
- `feature` branch *may* branch off from `main` branch but *must* merge back into the `release` branch only.
- `release` branch *may* branch off from `main` branch but *must* merge into `main` and `release` branch with the naming convention `release-*`(e.g., `release-v3.1.0`).
- `bugfix` branch *must* branch off from the `main` branch and *must* merge back into `main`and the respective `release` branch with the naming convention `bugfix-*`(e.g., `bugfix-v3.1.1` ).
- `feature` branch *may* branch off from `main` branch but *must* merge back into the `main` branch only.
- `release` branch *may* branch off from `main` branch with the naming convention `release-*`(e.g., `release-v3.x`).
- `bugfix` branch *must* branch off from the `main` and / or `release` branch and *must* merge / cherry pick back into the respective `main` / `release` branch with the naming convention `bugfix-{description}`or `bugfix-issue-nr`(e.g., `bugfix-issue-21`).

> **Housekeeping:** Only permanent branches are main, develop, release-v0.0.x; other branches are deleted once merged.
![Branching Strategy according to - https://nvie.com/posts/a-successful-git-branching-model/](branching_strategy.png)
> **Housekeeping:** Only permanent branches are main and release-v3.x; other branches such as features or bugfixes are deleted once merged.

## Releases
Expand Down

0 comments on commit 25f88ee

Please sign in to comment.