33 lines
1.8 KiB
Markdown
33 lines
1.8 KiB
Markdown
---
|
|
tags:
|
|
- Methoden
|
|
---
|
|
Für das Erstellen der Thesis werden folgende Werkzeuge, die mit folgendem Zweck verwendet werden.
|
|
|
|
| Werkzeug | Zweck |
|
|
| ---------------- | -------------------------------------------------------- |
|
|
| Obsidian | Knowledge Graph, Persönliche Dokumentation, Organisation |
|
|
| Gitea | Online Repository und Code Organisation, Management |
|
|
| LaTeX / Typst | Schreiben der Thesis / Exposé |
|
|
| Zotero | Dokumentation und Datenbank der verwendeten Quellen |
|
|
| DrawIO / Mermaid | Graphenerstellung |
|
|
| VSCode | Development Environment |
|
|
| Python | Ausgewählte Programmiersprache |
|
|
| Docker / Podman | Containerisierung |
|
|
| CI/CD | Gitea Worker |
|
|
|
|
# Repository Strategien
|
|
|
|
## Branching
|
|
Für Sicherheitserhöhung soll parallel zum `main` Branch ein `beta` Branch existieren. Arbeitspakete gehen vom `beta` Branch aus und werden bereits dort durch die CI/CD-Pipeline. Damit soll mehrfach geprüft werden, dass implementierte Module / Features vernünftig funktionieren und Probleme nicht direkt auf den `main` Branch veröffentlicht werden.
|
|
|
|
## CI / CD
|
|
Für die CI/CD Pipeline sind folgende Module von Interesse:
|
|
1. Linter
|
|
2. Modultests
|
|
3. Automatische Generierung der Dokumentation
|
|
|
|
# Code Stil
|
|
Für den Code Stil wird sich an die Vorgaben durch Google gehalten, folgender [Styleguide](https://google.github.io/styleguide/pyguide.html) wird dafür verwendet. Dem Linter wird dieses Styleguide ebenfalls übergeben, sodass die Code-Architektur Einheitlich durchgeführt wird.
|
|
|