From 9ad62d72cc1da55fd7f470482bd1a6cb9b690f78 Mon Sep 17 00:00:00 2001 From: gulerdav Date: Fri, 14 Oct 2022 15:27:49 +0200 Subject: [PATCH] Update README.md --- README.md | 41 ++++++++++++++++++++++------------------- 1 file changed, 22 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index afc890d..5b7f091 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,26 @@ PM3 FivePlants Gartenverwaltung ## Class Diagram Umletino: https://www.umletino.com/umletino.html -## Branch model -- active branch: *main* - - -This branch has a running version of the code. -- feature: *feature_xy_"Milestone"* - - -This branches contain code for feature. When the code is ready it will be merged into the main branch. -- bugfix: *bugfix_xy_"Milestone"* - - -This branch are for bugfixes. -- documentation: *doc_xy_"Milestone"* - - -This branch is for documentation of the code and the readme. - - Draft File: doc/ClassDiagramDraft.uxf + +## Branch model +- production branch: `main` + +This branch has a working version of the code. + +- development branch: `dev` + +This branch should contain a running (although not necessarily working) version of the code. Working states are to be merged into the `main` branch regularly. + +- feature: `feature_xy_` + +These branches contain features in active development. When the code is ready it will be merged into the `dev` branch. + +- bugfix: `bugfix_xy_` + +These branches are for bugfixes. + +- documentation: `doc_xy_` + +These branches are for javadoc and project documentation (such as the readme, class diagrams etc.). +