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
60 lines
2.1 KiB
Markdown
60 lines
2.1 KiB
Markdown
# CLAUDE.md
|
||
|
||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||
|
||
## Projekt
|
||
|
||
**Gartenmanager** – eine Anwendung zur Verwaltung und Planung von Gartenaktivitäten (Pflanzen, Aussaatkalender, Aufgaben, Bewässerung etc.).
|
||
|
||
## Weiterführende Dokumente
|
||
|
||
| Dokument | Inhalt |
|
||
|---|---|
|
||
| [docs/development-standards.md](docs/development-standards.md) | Entwicklungsstandards, Branching-Regeln, Versionierung, Workflow |
|
||
| [docs/project-structure.md](docs/project-structure.md) | Projektstruktur, Module, Funktionsübersicht |
|
||
| [docs/branching-strategy.md](docs/branching-strategy.md) | Branching-Diagramm |
|
||
| [CHANGELOG.md](CHANGELOG.md) | Versionshistorie |
|
||
| [VERSION](VERSION) | Aktuelle Versionsnummer |
|
||
|
||
## Techstack
|
||
|
||
> Noch festzulegen – diese Sektion aktualisieren, sobald der Stack definiert ist.
|
||
|
||
## Build & Entwicklung
|
||
|
||
> Befehle eintragen, sobald Build-System definiert ist.
|
||
|
||
```bash
|
||
# Abhängigkeiten installieren
|
||
# <install-command>
|
||
|
||
# Entwicklungsserver starten
|
||
# <dev-command>
|
||
|
||
# Tests ausführen
|
||
# <test-command>
|
||
|
||
# Einzelnen Test ausführen
|
||
# <single-test-command>
|
||
|
||
# Linting
|
||
# <lint-command>
|
||
|
||
# Build für Produktion
|
||
# <build-command>
|
||
```
|
||
|
||
## Pflichtregeln (immer befolgen)
|
||
|
||
1. **Nie direkt nach `main` pushen/mergen** – ausschließlich per Pull-Request, und nur auf explizite Anweisung.
|
||
2. **Branching:** Jede Arbeit in einem `feature/` oder `fix/` Branch unter `develop`. Erst nach dev mergen, wenn alles fertig und alle Tests grün sind.
|
||
3. **Nach jeder Änderung:** Versionsnummer erhöhen (`VERSION` + `CHANGELOG.md`), committen und pushen.
|
||
4. **Vor Merge nach dev / PR nach main:** README.md, CHANGELOG.md und docs/ prüfen und aktualisieren.
|
||
5. **Projektstruktur-Doku** (`docs/project-structure.md`) bei jeder Funktions-/Moduländerung synchron halten.
|
||
6. **Versionierung:** `MAJOR.MINOR.PATCH` – MAJOR nur auf Anweisung, MINOR bei Features, PATCH bei Fixes/Kleinänderungen.
|
||
|
||
## Wichtige Konventionen
|
||
|
||
- Sprache: Deutsch für Domänenkonzepte (Pflanzen, Beet, Aussaat …), Englisch für Code-Bezeichner und Commit-Messages
|
||
- Alle Dateipfade in den `docs/`-Dokumenten aktuell halten, wenn sich die Struktur ändert
|