Checkliste - modified Module veröffentlichen im MMLC

Bevor du ein Modul für das modified Shopsystem im MMLC veröffentlichst, solltest du einige entscheidende Schritte durchführen, um die Qualität und die Nutzererfahrung auf ein hohes Niveau zu bringen.

Info: Wenn du wissen möchstest, wie der technische Ablauf einer Modulveröffentlichung im MMLC funktioniert. Schau dir das Tutorial Tutorial: Dein erstes modified eCommerce Shop Modul veröffentlichen an.

Checkliste in Kürze #

Hier findest du die Checkliste in Kürze. Du kannst die Liste direkt abhaken.

  • Update-Mechanismus integrieren
  • Tests durchführen
  • Abhängigkeiten in der moduleinfo.json kontrollieren und aktualisieren
  • Changelog Eintrag erstellen
  • Fehlermeldungen in Logs kontrollieren und vermeiden
  • Lokalisierung und Übersetzungen erstellen
  • Installationsanleitung erstellen
  • Bedienungsanleitung erstellen
  • Beschreibung erstellen
  • Icon erstellen

Update-Mechanismus integrieren #

Gewährleiste, dass dein Modul mithilfe des MMLC einfach aktualisiert werden kann. Bei Aktualisierungen ist es wichtig zu bedenken, dass nicht nur Quellcode-Dateien über den MMLC aktualisiert werden müssen, sondern sich auch Daten und Einstellungen in der Datenbank ändern können. Es ist entscheidend, dass dein Modul in der Lage ist, diese Anpassungen automatisch vorzunehmen, um einen reibungslosen Übergang für die Nutzer zu gewährleisten.

Wenn du das Standard Modul für Modified verwendest, stehen dir bereits vorgefertigte Hilfsmethoden zur Verfügung, die dir die Implementierung dieses Mechanismus erheblich erleichtern. Diese Hilfsmethoden sind speziell darauf ausgerichtet, Änderungen in der Datenbank und den Einstellungen nahtlos zu handhaben. In der Anleitung Modul-Updates mit dem Modifed Standard Modul implementieren findest du hilfreiche Informationen dazu.

Ein weiterer wichtiger Schritt ist die Dokumentation im Changelog. Hier solltest du detailliert beschreiben, wie das Modul aktualisiert werden kann. Falls die Aktualisierung nur einen einfachen Klick im Backend auf "Update" erfordert, ergänze diesen Schritt ebenfalls im Changelog.

Eine klare und verständliche Anleitung zur Aktualisierung stellt sicher, dass Nutzer ohne Schwierigkeiten von ältere auf neuere Versionen deines Moduls umsteigen können.

Tests durchführen #

Führe vor der Veröffentlichung deines Moduls umfassende Tests durch, um sicherzustellen, dass es in einwandfreiem Zustand ist. Es ist besonders wichtig, die Kernfunktionalitäten gründlich zu überprüfen, da diese das Herzstück deines Moduls bilden. Um diesen Prozess effizient zu gestalten, empfiehlt es sich, eine Liste von Testszenarien zu erstellen, die manuell überprüft werden können. Diese Liste sollte dokumentiert und zu deinem Projekt gespeichert werden. Auf diese Weise kannst du bei kommenden Versionen deines Moduls dieselben Tests erneut durchführen, um sicherzustellen, dass keine neuen Probleme aufgetreten sind und die Qualität beibehalten wird.

Eine zusätzliche Maßnahme zur Verbesserung der Testqualität ist die Implementierung automatisierter Tests. Hierbei stehen dir hilfreiche Tools wie PHPUnit und Codeception zur Verfügung. Diese Tools ermöglichen es, wiederholbare Testszenarien zu erstellen und automatisch auszuführen. Automatisierte Tests können die Testabdeckung erhöhen und die Entdeckung von Fehlern erleichtern, insbesondere bei komplexen Modulen.

Um sicherzustellen, dass dein Modul reibungslos funktioniert, solltest du es mindestens in folgender Umgebung testen:

  • Die aktuellste stabile Version des modified Shops
  • Die aktuellste von modified unterstützte PHP Version
  • Die aktuellste stabile Version des MMLC

Abhängigkeiten in der moduleinfo.json kontrollieren und aktualisieren #

Aktualisiere deine moduleinfo.json Datei. Hier solltest du als erstes die folgenden Versionen eintragen, unter denen du das Modul getestet hast.

  • MMLC Version
  • PHP Version
  • modified Version

Changelog Eintrag erstellen #

Du kannst als Vorlage folgendes Dokument verwenden: https://github.com/ModifiedCommunityModules/recover-cart-sales/blob/master/changelog.md

Fehlermeldungen in Logs kontrollieren und vermeiden #

Eine sorgfältige Überwachung und Minimierung von Fehlermeldungen in den Logdateien ist ein wichtiger Schritt, um sicherzustellen, dass dein Modul reibungslos funktioniert und die Benutzererfahrung nicht beeinträchtigt wird.

Begebe dich in das Verzeichnis log in deines modified Systems, in dem Protokolldateien (Logs) gespeichert werden. Dein Ziel sollte darin bestehen, die Anzahl der ERROR, WARNING oder NOTICE Meldungen, die von deinem Modul erzeugt werden, zu minimieren. Obwohl es nicht immer möglich ist, alle Fehlermeldungen zu vermeiden, ist es dennoch von großer Bedeutung, sie auf ein Minimum zu reduzieren.

Lokalisierung und Übersetzungen erstellen #

Die Bereitstellung von mehrsprachiger Unterstützung für dein Modul ist ein wesentlicher Schritt, um sicherzustellen, dass es in einer breiteren Benutzerbasis effektiv genutzt werden kann. Obwohl das modified System hauptsächlich im deutschen Sprachraum eingesetzt wird, gibt es dennoch eine internationale Gemeinschaft von Nutzern, die von dieser zusätzlichen Funktionalität profitieren kann. Passe dein Modul mindestens für folgende Sprachen an:

  • Deutsch
  • Englisch

Installationsanleitung erstellen #

Erstelle eine Installationsanleitung. Eine klare und umfassende Installationsanleitung ist von entscheidender Bedeutung, um die reibungslose Integration deines Moduls in die Shop-Umgebung zu gewährleisten. Du kannst die Installationsanleitung für das Offene Warenkörbe Modul als Vorlage verwenden.

Im MMLC kannst du dazu eine Markdown-Datei mit dem Namen install.md im Verzeichnis docs erstellen. Das Verzeichnis muss sich im Root-Verzeichnis des Moduls befinden.

Bedienungsanleitung erstellen #

Erstelle eine Bedienungsanleitung. Die Erstellung einer umfassenden Bedienungsanleitung für dein Modul ist von großer Bedeutung, um Benutzern bei der optimalen Nutzung deiner Erweiterung zu helfen.

Im MMLC kannst du dazu eine Markdown-Datei mit dem Namen usage.md im Verzeichnis docs erstellen. Das Verzeichnis muss sich im Root-Verzeichnis des Moduls befinden.

Beschreibung erstellen #

Erstelle eine Beschreibung deines Moduls. Die Erstellung einer umfassenden Modulbeschreibung ist von Bedeutung, da sie Benutzern bei der Auswahl der Module unterstützt und ihnen ein klares Verständnis darüber vermittelt, was sie von deinem Modul erwarten können. Eine sorgfältig ausgearbeitete Beschreibung sollte relevante Informationen enthalten, die sowohl die Funktionalität als auch den Nutzen deines Moduls hervorheben.

Im MMLC kannst du dazu eine Markdown-Datei mit dem Namen description.md im Verzeichnis docs erstellen. Das Verzeichnis muss sich im Root-Verzeichnis des Moduls befinden.

Modul Icon erstellen #

Erstelle ein Icon für den MMLC und für das Modul in den Systemeinstellungen des modified Shops. Verwende jeweils das gleiche Icon, damit der Nutzer das Modul leichter erkennt. Die Erstellung eines eindeutigen Icons für dein Modul ist von großer Bedeutung, da es die Wiedererkennung erheblich steigert.

Im MMLC kannst du dazu eine PNG-Datei mit dem Namen icon.png im Root-Verzeichnis deines Moduls erstellen.