chore: establish workflow rules, versioning and changelog

Add mandatory workflow rules (branching, versioning, docs-sync),
introduce CHANGELOG.md and VERSION file, update development
standards and CLAUDE.md accordingly.

Version: 0.1.1
This commit is contained in:
Faultier314
2026-04-05 22:17:10 +02:00
parent 3dceae930c
commit cd7a3f7414
4 changed files with 81 additions and 9 deletions

View File

@@ -13,17 +13,26 @@ Allgemein gültige Standards für die Arbeit in diesem Repository.
---
## Git
## Git & Branching
### Branching
### Struktur
```
main stabiler Produktionsstand
feature/<name> neue Features
fix/<name> Bugfixes
chore/<name> Wartung, Abhängigkeiten, Konfiguration
main
└── develop
├── feature/<name> neue Features
├── fix/<name> Bugfixes / kleine Fixes
└── debug/<name> Debugging / Fehleranalyse
```
### Regeln
1. **Nie direkt nach `main` pushen oder mergen.** Änderungen in `main` kommen ausschließlich über eine Pull-Request aus `develop`.
2. Jede Änderung findet in einem eigenen `feature/` oder `fix/` Branch unterhalb von `develop` statt.
3. In `develop` mergen erst, wenn die Arbeit abgeschlossen ist und alle Tests erfolgreich waren.
4. Eine PR nach `main` wird nur auf explizite Anweisung des Nutzers geöffnet.
5. Vor jedem Merge nach `develop` und vor jeder PR nach `main` werden alle wesentlichen Dokumente (README.md, CHANGELOG.md, docs/) geprüft und ggf. aktualisiert.
### Commit-Messages
Format: `<type>: <short description>` (max. 72 Zeichen)
@@ -37,7 +46,31 @@ Format: `<type>: <short description>` (max. 72 Zeichen)
| `docs` | Nur Dokumentation |
| `chore` | Build, Dependencies, Konfiguration |
Beispiel: `feat: add watering schedule to plant detail view`
**Nach jedem Commit wird sofort gepusht.**
---
## Versionierung
Schema: `MAJOR.MINOR.PATCH`
| Teil | Bedeutung | Wechsel |
|---|---|---|
| `MAJOR` | Hauptrelease | Nur auf explizite Anweisung des Nutzers |
| `MINOR` | Größere Updates, neue Features | Bei jeder Feature-Erweiterung oder größerem Umbau |
| `PATCH` | Kleine Fixes, Minimalkorrekturen | Bei Bugfixes, kleinen Ergänzungen, Mini-Umbauten |
- Die aktuelle Version steht in [CHANGELOG.md](../CHANGELOG.md) und in der Datei `VERSION`
- Nach **jeder** Änderung wird die Versionsnummer eigenständig erhöht und in beiden Dateien notiert
- Die Versionsnummer wird im Commit-Message-Footer vermerkt: `Version: x.y.z`
---
## Projektstruktur-Dokumentation
- Alle Funktionen/Module werden kurz in [docs/project-structure.md](project-structure.md) dokumentiert
- Ziel: Token-Effizienz in zukünftigen Conversations nicht alles neu einlesen müssen
- Bei jeder Änderung an Funktionen/Modulen wird die Dokumentation synchron aktualisiert
---
@@ -56,6 +89,7 @@ Beispiel: `feat: add watering schedule to plant detail view`
- Integrationstests an Systemgrenzen (API, Datenbank)
- Keine Mocks für die Datenbank in Integrationstests
- Testdatei liegt neben der zu testenden Datei oder in einem `__tests__`/`tests`-Verzeichnis auf gleicher Ebene
- **In `develop` wird erst gemergt, wenn alle Tests grün sind**
---