Contribution Developer ​

Das Mate Design System lebt von der aktiven Beteiligung unserer Entwickler-Community. Wir schätzen jede Unterstützung, die dazu beiträgt, das System zu verbessern und weiterzuentwickeln. Über das AKDB GitLab kannst du neue Features vorschlagen, Bugs melden oder direkt Code beitragen – so gestaltest du die Weiterentwicklung aktiv mit.

Schritte zur Contribution ​

  1. Zugang zu GitLab: Stelle sicher, dass du Zugriff auf das AKDB GitLab hast. Falls nicht, wende dich an Tim Giesbrecht, um einen Zugang zu erhalten.
  2. Repository klonen: Klone das Repository des Mate Design Systems auf deinen Rechner, um Änderungen vorzunehmen.

    git clone https://git.akdb.de/akdb/ds/mate/web-components.git
  3. Branch erstellen: Erstelle einen neuen Branch für deine Änderung und benenne ihn aussagekräftig (z.B. feature/neue-komponente oder bugfix/button-styles).

    git checkout -b feature/neue-komponente
  4. Änderungen vornehmen: Nimm deine gewünschten Änderungen vor und teste sie lokal, um sicherzustellen, dass alles wie erwartet funktioniert.
  5. Commit & Push: Speichere deine Änderungen mit einem klaren Commit-Kommentar und push den Branch in das GitLab-Repository.

    git commit -m "Kurze Beschreibung der Änderung" git push origin feature/neue-komponente
  6. Merge Request erstellen: Öffne in GitLab einen Merge Request (MR) für deinen Branch. Beschreibe im MR ausführlich die Änderungen und den Zweck, damit das Review-Team den Kontext versteht.

Review Prozess ​

Alle Contributions werden vom Entwicklungsteam überprüft. Feedback oder Anmerkungen erhältst du direkt im Merge-Request über GitLab. Je nach Umfang und Komplexität kann die Prüfung etwas Zeit in Anspruch nehmen – hab hier bitte etwas Geduld. Sobald dein Beitrag freigegeben ist, wird er in den Hauptzweig (Main Branch) des Projekts übernommen und steht mit dem nächsten Release zur Verfügung.

Best Practices für Contributions ​

  • Dokumentation: Achte darauf, alle Änderungen auch in der Dokumentation festzuhalten (z.B. in Storybooks oder Demos), insbesondere bei neuen Komponenten oder Funktionen.
  • Tests: Führe möglichst Tests oder visuelle Prüfungen durch, um sicherzustellen, dass bestehende Funktionen nicht beeinträchtigt werden. (Zum Beispiel kannst du npm run wdio ausführen, um visuelle Regressionen der Komponenten auszuschließen.)
  • Coding Guidelines: Halte dich an die definierten Code-Konventionen und Standards des Mate Design Systems, damit dein Beitrag nahtlos zur Codebasis passt.

Community und Support ​

Die Mitarbeit am Mate Design System ist eine tolle Gelegenheit, dich in der Entwicklergemeinschaft einzubringen und wertvolle Erfahrungen zu sammeln. Wenn du Fragen zum Contribution-Prozess hast oder Unterstützung benötigst, steht dir unser Team gern zur Verfügung. Wir ermutigen dich außerdem, dich in unserer Entwickler-Usergroup auszutauschen und deine Ideen zu diskutieren.