Update README.md
This commit is contained in:
parent
bd53d0644a
commit
9ad62d72cc
41
README.md
41
README.md
|
@ -4,23 +4,26 @@ PM3 FivePlants Gartenverwaltung
|
||||||
## Class Diagram
|
## Class Diagram
|
||||||
Umletino: https://www.umletino.com/umletino.html
|
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
|
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_<Milestone>`
|
||||||
|
|
||||||
|
These branches contain features in active development. When the code is ready it will be merged into the `dev` branch.
|
||||||
|
|
||||||
|
- bugfix: `bugfix_xy_<Milestone>`
|
||||||
|
|
||||||
|
These branches are for bugfixes.
|
||||||
|
|
||||||
|
- documentation: `doc_xy_<Milestone>`
|
||||||
|
|
||||||
|
These branches are for javadoc and project documentation (such as the readme, class diagrams etc.).
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue