-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- update
github-action so that the docs are built once a week
- add diagrams for
- git strategy
- time scheduling (project management)
- add chapters for thesis documentation- Loading branch information
1 parent
417fa19
commit c07ec66
Showing
11 changed files
with
269 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Delimitation | ||
|
|
||
| (Abgrenzung) | ||
|
|
||
| Start typing here ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| # Git Strategy | ||
|
|
||
| GitFlow is a workflow that defines a strict branching model designed around the project release. It assigns very | ||
| specific roles to different branches and defines how and when they should interact. This workflow is great for larger | ||
| projects with several developers and release cycles. | ||
|
|
||
| In GitFlow, there are two main branches: the `master` branch and the `develop` branch. The `master` branch stores the | ||
| official release history, and the `develop` branch serves as an integration branch for features. | ||
|
|
||
| New features are developed on `feature` branches that branch off from `develop` and must merge back into `develop`. When | ||
| the team is ready to release a new version, a `release` branch is created off `develop`. This branch is used for testing | ||
| and bug fixing for the release. Once the release is ready to go live, it is merged into `master` and `develop`. | ||
|
|
||
| If a critical bug is found in the production version, a `hotfix` branch is created off `master`. Once the bug is fixed, | ||
| the `hotfix` branch is merged back into both `master` and `develop`. | ||
|
|
||
| This workflow ensures a clean project history and helps manage complex projects by separating different types of work | ||
| into different branches. | ||
|
|
||
| ```mermaid | ||
| --- | ||
| title: Example Git diagram | ||
| --- | ||
| gitGraph | ||
| commit | ||
| commit | ||
| branch develop | ||
| checkout develop | ||
| commit | ||
| commit | ||
| checkout main | ||
| merge develop | ||
| commit | ||
| commit | ||
| ``` | ||
|
|
||
| 1. **Start**: The workflow begins with the develop branch, which is the main branch where the development takes place. | ||
|
|
||
| 2. **New Feature**: If there's a new feature to be added, a new feature branch is created from the develop branch. The | ||
| feature is developed in this branch. | ||
|
|
||
| 3. **Merge Feature**: Once the feature is complete, the feature branch is merged back into the develop branch. The | ||
| process then loops back to check if there are more features to add. | ||
|
|
||
| 4. R**elease Time**: If there are no more features to add and it's time for a release, a release branch is created from | ||
| the develop branch. The release is prepared in this branch (like bumping the version number, final testing, etc.). | ||
|
|
||
| 5. **Merge Release**: Once the release is ready, the release branch is merged into both the master and develop branches. | ||
| The release is then tagged in the master branch, and the release branch is deleted. | ||
|
|
||
| 6. **Bug Fix**: If there's a bug to fix in the develop branch, a bugfix branch is created. The bug is fixed in this | ||
| branch, and then the bugfix branch is merged back into the develop branch. The process then loops back to check if | ||
| there are more bugs to fix. | ||
|
|
||
| 7. **Hotfix**: If there's a critical bug in production, a hotfix branch is created directly from the master branch. The | ||
| bug is fixed in this branch, and then the hotfix branch is merged into both the master and develop branches. The | ||
| hotfix is then tagged in the master branch, and the hotfix branch is deleted. | ||
|
|
||
| 8. **End**: If there are no more features to add, no more releases to prepare, no more bugs to fix, and no more hotfixes | ||
| to apply, the process ends until there's a new feature, release, bug, or hotfix. | ||
|
|
||
| ```mermaid | ||
| %%{init: { 'logLevel': 'debug', 'theme': 'dark' } }%% | ||
| gitGraph | ||
| commit | ||
| branch hotfix | ||
| checkout hotfix | ||
| commit | ||
| branch develop | ||
| checkout develop | ||
| commit id: "ash" tag: "abc" | ||
| branch featureB | ||
| checkout featureB | ||
| commit type: HIGHLIGHT | ||
| checkout main | ||
| checkout hotfix | ||
| commit type: NORMAL | ||
| checkout develop | ||
| commit type: REVERSE | ||
| checkout featureB | ||
| commit | ||
| checkout main | ||
| merge hotfix | ||
| checkout featureB | ||
| commit | ||
| checkout develop | ||
| branch featureA | ||
| commit | ||
| checkout develop | ||
| merge hotfix | ||
| checkout featureA | ||
| commit | ||
| checkout featureB | ||
| commit | ||
| checkout develop | ||
| merge featureA | ||
| branch release | ||
| checkout release | ||
| commit | ||
| checkout main | ||
| commit | ||
| checkout release | ||
| merge main | ||
| checkout develop | ||
| merge release | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Implementation | ||
|
|
||
| Start typing here... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Initial situation | ||
|
|
||
| Start typing here... (Ausgangslage) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Procedure and methodology | ||
|
|
||
| Start typing here... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,28 @@ | ||
| # Raptor | ||
|
|
||
| Start typing here... | ||
| Start typing here... | ||
|
|
||
| ```mermaid | ||
| %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchName': 'MetroLine1'}} }%% | ||
| gitGraph | ||
| commit id:"NewYork" | ||
| commit id:"Dallas" | ||
| branch MetroLine2 | ||
| commit id:"LosAngeles" | ||
| commit id:"Chicago" | ||
| commit id:"Houston" | ||
| branch MetroLine3 | ||
| commit id:"Phoenix" | ||
| commit type: HIGHLIGHT id:"Denver" | ||
| commit id:"Boston" | ||
| checkout MetroLine1 | ||
| commit id:"Atlanta" | ||
| merge MetroLine3 | ||
| commit id:"Miami" | ||
| commit id:"Washington" | ||
| merge MetroLine2 tag:"MY JUNCTION" | ||
| commit id:"Boston" | ||
| commit id:"Detroit" | ||
| commit type:REVERSE id:"SanFrancisco" | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| # Scheduling | ||
|
|
||
| Start typing here... | ||
|
|
||
| [Link to time schedule](https://docs.google.com/spreadsheets/d/1NVJV-sXO0yzrbKqA5deLzzR0VaGW3y-0jaoxKCRQ4sk/edit?usp=sharing) | ||
|
|
||
| | Person | KW10 | KW11 | KW12 | KW13 | KW14 | KW15 | KW16 | KW17 | KW18 | KW19 | KW20 | KW21 | KW22 | KW23 | KW24 | KW25 | KW26 | KW27 | KW28 | KW29 | KW30 | KW31 | KW32 | KW33 | KW34 | KW35 | KW36 | Total | | ||
| |---------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|------|-------| | ||
| | Merlin | | | | | | | | | | | | | | | | | | | | | | | | | | | | 375h | | ||
| | Lukas | | | | | | | | | | | | | | | | | | | | | | | | | | | | 375h | | ||
| | Michael | | | | V🌴 | 8h | 4h | 9h | 8h | 2h | 20h | 12h | 13h | | | | | | | | | | | | | | | | 375h | | ||
|
|
||
| ## Legend | ||
|
|
||
| | Symbol | Meaning | | ||
| |--------|-------------------------------------| | ||
| | KW | Calendar Week | | ||
| | V🌴 | Vacation | | ||
| | Total | Sum of time estimates for all weeks | | ||
|
|
||
| ```mermaid | ||
| gantt | ||
| dateFormat YYYY-MM-DD | ||
| title Arbeitsstundenplan | ||
| section Merlin | ||
| März: a1, 2022-03-01, 31d | ||
| April: a2, after a1, 30d | ||
| Mai: after a2, 31d | ||
| Juni: after a1, 30d | ||
| Juli: after a1, 31d | ||
| August: after a1, 31d | ||
| September: after a1, 30d | ||
| Total: crit, 2022-03-01, 204d | ||
| section Lukas | ||
| März: b1, 2022-03-01, 31d | ||
| April: after b1, 30d | ||
| Mai: after b1, 31d | ||
| Juni: after b1, 30d | ||
| Juli: after b1, 31d | ||
| August: after b1, 31d | ||
| September: after b1, 30d | ||
| Total: crit, 2022-03-01, 204d | ||
| section Michael | ||
| März: c1, 2022-03-01, 31d | ||
| April: after c1, 30d | ||
| Mai: after c1, 31d | ||
| Juni: after c1, 30d | ||
| Juli: after c1, 31d | ||
| August: after c1, 31d | ||
| September: after c1, 30d | ||
| Total: crit, 2022-03-01, 204d | ||
| ``` | ||
|
|
||
| ```mermaid | ||
| timeline | ||
| title MermaidChart 2023 Timeline | ||
| section 2024 MARCH <br> Analysis | ||
| Merlin: KW11 (8h): KW12 (8h) | ||
| : KW13 (8h) | ||
| Lukas: KW11 (8h): KW12 (8h) | ||
| : KW13 (8h) | ||
| Michael: KW11 (8h): KW12 (8h) | ||
| : KW13 (8h) | ||
| section 2024 APRIL <br> Analysis | ||
| Merlin: KW11 (8h): KW12 (8h) | ||
| : KW13 (8h) | ||
| Lukas: KW11 (8h): KW12 (8h) | ||
| : KW13 (8h) | ||
| Michael: KW11 (8h): KW12 (8h) | ||
| : KW13 (8h) | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Thesis | ||
|
|
||
| Start typing here... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters