Skip to content

[CODINGSTANDARD] Lizenz- und Modul-Boilerplates in eigenen Frontenddateien vervollständigen #554

Description

@ralferlebach

Problem

Viele eigene JavaScript-, TypeScript-, Vue- und CSS-Dateien besitzen keinen konsistenten GPL-v3+-Header beziehungsweise keine eindeutige Komponenten- und Modulbeschreibung.

Ursache

Frontendquellen folgen keiner einheitlichen Moodle-Dateivorlage; generierte und fremde Dateien sind nicht klar getrennt.

Lösung

  • Eigene verteilte Quelldateien mit korrektem GPL-Header versehen.
  • AMD-Entrypoints mit passendem @module dokumentieren.
  • Generierte Dateien kennzeichnen.
  • Third-Party-Dateien nicht mit eigenen Headern überschreiben, sondern deklarieren.

Manuelles Testverfahren

Testschritte

  1. Statischen Header-Scan auf eigene Quellverzeichnisse ausführen.
  2. Third-Party-Pfade getrennt prüfen.

Aktuelles Ist-Verhalten

Viele eigene JavaScript-, TypeScript-, Vue- und CSS-Dateien besitzen keinen konsistenten GPL-v3+-Header beziehungsweise keine eindeutige Komponenten- und Modulbeschreibung.

Erwartetes Soll-Verhalten

Alle eigenen Quellen besitzen korrekte Boilerplates.

Automatisierte Tests

  • CI-Lizenzheader-Check mit Ausnahmeliste für generierte/Fremddateien.

Akzeptanzkriterien

  • Alle eigenen Quellen besitzen korrekte Boilerplates.
  • Fremd- und Builddateien sind eindeutig identifizierbar.
  • Keine falschen Copyrightangaben.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions