Files
breadcrumb-the-shire/docs/erste-aenderung.md
fs 25370a1a55 add composer-unused, comprehensive docs, and project restructure
- Add icanhazstring/composer-unused as dev dependency for dependency hygiene checks
- Add German documentation (docs/) covering architecture, conventions, workflows, and developer checklists
- Add API layer (ApiAuth, ApiBootstrap, ApiResponse), audit, scheduler, custom fields, and SSO services
- Add Microsoft OIDC SSO, API token management, and user lifecycle features
- Add swagger-ui vendor integration and OpenAPI spec
- Add production Docker setup and bin/ scripts
- Update composer dependencies, config, templates, and frontend assets throughout

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-02-22 15:27:35 +01:00

1.6 KiB

Leitfaden für die erste Änderung

Letzte Aktualisierung: 2026-02-21

Ziel

Ein neuer Entwickler soll den ersten Change strukturiert und reproduzierbar umsetzen können.

Beispiel 1: Spalte in Admin-Liste ergänzen

Schrittfolge

  1. Data-Endpoint erweitern (z. B. pages/admin/users/data().php)
  2. Falls nötig: neue Repository-Query/Count-Methode (z. B. lib/Repository/User/UserRepository.php)
  3. Grid-Spalte in pages/admin/<modul>/index(default).phtml ergänzen (z. B. pages/admin/users/index(default).phtml)
  4. i18n-Key für Spaltennamen setzen
  5. php -l + manueller UI-Test

Done-Kriterien

  • Kein SQL in View-Dateien
  • Neue Werte im Endpoint dokumentiert/benannt
  • Sortierung und Mapping im Grid konsistent
  • Bei neuen Filtern: Query-Param, Repository-Filter und Grid-State konsistent

Beispiel 2: API-Response erweitern

Schrittfolge

  1. Endpoint in pages/api/v1/... anpassen (z. B. pages/api/v1/me/index().php oder pages/api/v1/users/show($id).php)
  2. Permission- und Tenant-Scope-Prüfungen beibehalten
  3. Optional Service/Repository ergänzen
  4. docs/openapi.yaml aktualisieren
  5. docs/api.md mit Beispiel aktualisieren
  6. Bei neuen Berechtigungen: PermissionService + init.sql synchron halten, für Bestandsumgebungen idempotentes SQL-Update bereitstellen

Done-Kriterien

  • Keine numerischen IDs exponieren, wenn UUID bereits Contract ist
  • Fehlercodes konsistent (ApiResponse::error(...))
  • Kein Body-Leak in Logs/Audit
  • OpenAPI und tatsächlich gelieferte Response-Felder stimmen 1:1

Finaler Check

Vor PR/Merge diese Liste gegenprüfen:

  • /docs/entwickler-checkliste.md