Loheide-eu-mitarbeiterplatt.../CONTRIBUTING.md
Friederich Loheide 9c0f8de791
Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 1m14s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Successful in 1m12s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 1m7s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 1m19s
CI / PHP 8.3 / mysql:8.0 (pull_request) Successful in 1m32s
CI / PHP 8.4 / mysql:8.0 (pull_request) Successful in 1m22s
CI / PHP 8.4 / mysql:8.4 (pull_request) Successful in 1m32s
CI / PHP 8.3 / mysql:8.4 (pull_request) Successful in 1m35s
CI / Build-Artefakte aktuell (pull_request) Failing after 1m7s
Phase 0: Fundament für Inhaus
- Laravel 13 mit Filament 5 (Admin), Inertia 3 + Vue 3 + Vuetify 4 (Material 3)
- Anmeldung über Fortify (Login, Passwort vergessen/ändern), keine Selbstregistrierung
- Profil mit Profilbild (WebP in festen Größen), Personenseiten, Header mit Avatar-Menü
- Material-3-Farbschema aus der Primärfarbe, hell/dunkel/System pro Person
- Basis-Branding (Portalname, Logo, Primärfarbe) im Admin unter „Erscheinungsbild“
- Benutzerverwaltung im Admin, Zugang vorläufig über is_admin
- vendor/ (ohne Dev-Pakete) und Frontend-Build mitversioniert, Dev-Pakete in vendor-dev/
- PHPUnit-Tests gegen MySQL/MariaDB, Forgejo-CI-Matrix, Docker-Entwicklungsumgebung
- VERSION, CHANGELOG.md und CONTRIBUTING.md mit Release-Ablauf

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-09-25 20:35:30 +00:00

2.7 KiB
Raw Blame History

Mitarbeit an Inhaus

Grundsatz: Das Repository ist das Release

Kunden installieren und aktualisieren Inhaus ohne Shell – auch auf Shared Webhosting. Der Self-Updater lädt den Stand des Branches als ZIP (main = Kanal „stable“, develop = Kanal „development“). Deshalb liegen im Repository auch alle Build-Artefakte:

Verzeichnis Inhalt erzeugt durch
vendor/ PHP-Pakete ohne Entwicklungsabhängigkeiten bin/build
public/build/ kompiliertes Portal-Frontend (Vue/Vuetify) bin/build
public/css/filament, public/js/filament, public/fonts/filament Filament-Assets php artisan filament:upgrade (läuft bei composer install)

Die CI prüft, dass diese Artefakte zum Quellcode passen.

Entwicklungsumgebung

Voraussetzungen: PHP 8.3 (Extensions: intl, zip, gd, pdo_mysql, bcmath, exif), Composer, Node 24, MySQL ≥ 8.0 oder MariaDB ≥ 10.6 – oder Docker (docker compose up -d, siehe docker-compose.yml).

Entwicklungspakete gehören nach vendor-dev/, nicht nach vendor/. bootstrap/autoload.php nimmt automatisch vendor-dev/, wenn es existiert.

export COMPOSER_VENDOR_DIR=vendor-dev   # am besten dauerhaft in die Shell-Konfiguration
composer install
cp .env.example .env && php artisan key:generate
php artisan migrate --seed              # Demo-Konto: admin@example.com / password
npm ci && npm run dev                   # oder: npm run build

Tests laufen gegen MySQL/MariaDB (Datenbank inhaus_test, Zugang wie in .env):

vendor-dev/bin/phpunit
vendor-dev/bin/pint

Neue Pakete immer mit gesetztem COMPOSER_VENDOR_DIR=vendor-dev hinzufügen und danach bin/build ausführen, damit vendor/ nachzieht.

Ablauf für jede Änderung

  1. CHANGELOG.md: neuen Abschnitt ## MAJOR.MINOR.PATCH ganz oben ergänzen – kurze deutsche Stichpunkte für Anwenderinnen und Anwender, keine Commit-Texte
  2. App\Version::VERSION in app/Version.php anheben (Patch = Fehlerbehebung, Minor = neue Funktion)
  3. Tests grün (vendor-dev/bin/phpunit), Code formatiert (vendor-dev/bin/pint)
  4. bin/build ausführen und vendor/ sowie public/build/ mitcommitten
  5. Merge in develop bzw. main – damit ist die Fassung sofort über den Self-Updater verfügbar

Konventionen

  • Oberflächentexte auf Deutsch mit echten Umlauten; technische Schlüssel, Routennamen, Tabellen und Spalten in ASCII/Englisch
  • Nur Funktionen nutzen, die MySQL und MariaDB beherrschen
  • Kein Node, kein Shell-Aufruf und kein Dauerprozess auf dem Server voraussetzen
  • Keine externen Ressourcen (CDNs, Google Fonts) einbinden – DSGVO
  • N+1-Abfragen vermeiden: Model::preventLazyLoading() ist außerhalb der Produktion aktiv